npm 包 @pandagardenio/semantic-release-lite 使用教程

简介

@pandagardenio/semantic-release-lite 是一个轻量级的 semantic-release 插件，可以帮助您更好地管理版本号和发布过程。它允许您基于 commit message 自动地更新您的版本号，并将新版本推送到您的代码库并发布到 npm 上。

安装

您可以通过 npm 安装 @pandagardenio/semantic-release-lite：

npm install @pandagardenio/semantic-release-lite --save-dev

配置

在您的 semantic-release 配置文件中添加 @pandagardenio/semantic-release-lite:

{
  "plugins": [
    "@pandagardenio/semantic-release-lite"
  ]
}

使用方法

@pandagardenio/semantic-release-lite 根据 commit message 中的关键字自动更新版本号，并执行 npm 发布和 git 推送，这意味着您只需要按照指定格式编写 commit message 即可实现一键发布。

指定关键字

默认情况下，@pandagardenio/semantic-release-lite 使用以下关键字：

• BREAKING CHANGE: 当您进行了不兼容的更改时
• feat: 当您增加了新功能时
• fix: 当您修复了 bug 时
• refactor: 当您重构了代码时
• chore: 当您更新了商业问题，如依赖项、文档等时

您可以在您的 package.json 文件的 semanticRelease 字段中覆盖默认设置：

{
  "semanticRelease": {
    "commitMessages": {
      "breaking": ["change"],
      "feature": ["feat"],
      "hotfix": ["fix"],
      "refactor": ["refactor"],
      "chore": ["chore"],
      "release": ["release"]
    }
  }
}

指定版本前缀和版本号格式

您可以在您的 package.json 文件的 semanticRelease 字段中指定版本前缀和版本号格式：

{
  "semanticRelease": {
    "versionPrefix": "v",
    "format": "${version}"
  }
}

示例代码

以下是使用 @pandagardenio/semantic-release-lite 的示例代码：

git commit -m 'feat: add new feature'
npm run release

执行上述命令后，@pandagardenio/semantic-release-lite 将自动更新版本号并发布到 npm 上。

总结

通过使用 @pandagardenio/semantic-release-lite，您可以自动化版本号管理和发布过程，从而提高整个项目的效率和可靠性。希望此文能够为您提供有价值的信息和指导。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/60067381890c4f7277584280