npm 包 @continuous-auth/semantic-release-npm 使用教程

简介

@continuous-auth/semantic-release-npm 是一个使用 Semantic Release 工具自动管理你的 npm 包版本控制和发布的 npm 包。Semantic Release 能够在 Git 提交历史的帮助下自动为每个版本控制的 npm 包生成 changelog 并发布到 npm 仓库上。

安装

你可以通过 npm 安装 @continuous-auth/semantic-release-npm 包：

$ npm install --save-dev @continuous-auth/semantic-release-npm

配置

你需要修改项目根目录下的 package.json 文件以配置 Semantic Release：

{
  "name": "your-package-name",
  "version": "1.0.0",
  "release": {
    "extends": "@continuous-auth/semantic-release-npm"
  }
}

上述配置采用了"extends"属性来使用 @continuous-auth/semantic-release-npm 这个 preset。

使用

你可以在你的发布脚本中运行 Semantic Release：

$ npx semantic-release

或者你可以使用 npm 脚本：

{
  "scripts": {
    "release": "semantic-release"
   }
}

$ npm run release

运行后，Semantic Release 会：

• 读取 Git 提交历史
• 根据提交历史决定版本号
• 自动构建并发布到 npm 仓库上
• 生成 changelog

高级用法

你可以根据你项目的需求来自定义 Semantic Release，比如添加一些自定义的 plugin 来满足特殊需求。更多信息请阅读 Semantic Release 高级用法文档

示例代码

修改 package.json 文件配置：

{
  "name": "my-awesome-package",
  "version": "0.0.0-dev",
  "release": {
    "extends": "@continuous-auth/semantic-release-npm"
  }
}

运行 npm 发布脚本：

$ npx semantic-release

或者运行 npm 脚本：

{
  "scripts": {
    "release": "semantic-release"
   }
}

$ npm run release

总结

在本文中，我们学习了如何使用 @continuous-auth/semantic-release-npm 这个 npm 包来自动管理 npm 包版本控制和发布。除此之外，我们还了解了如何自定义 Semantic Release 来满足特殊需求。希望本文能对你有所帮助！

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/96716