通过语义发布和人工编写的变更日志实现 npm 发布的自动化

原文：https://medium.com/hackernoon/automate-npm-releases-with-semantic-release-and-human-written-change-logs-2adb1dce487

在开源软件中，发布新版本是最枯燥乏味的任务之一。

有很多工具尝试自动化发布，其中最有趣的是语义发布。我很长一段时间都在避免使用它，因为它使提交消息生成的变更日志的发布完全自动化，并且我相信变更日志必须由人类编写。

但实际上它非常灵活，我能够对它进行定制，以完全满足我的需求:

一旦修复提交合并到主分支，就向 npm 发布新的修补程序版本，从提交消息生成 changelog。
推迟次要版本和主要版本，直到项目维护人员编写出合适的变更日志。
生成 changelog 草案:Markdown 文件，将最新版本以来的所有重要提交分为三个部分:重大更改、新功能和错误修复。

下面我将描述我自己实现这个工作流的脚本集。

它是如何工作的

语义发布在 CI 服务器上运行。
每次成功构建后，它都会分析新的提交，并查看是否有要发布的内容。
它通过分析提交消息来确定发布类型(补丁、小版本或大版本)(稍后将详细介绍)。
它生成一个 changelog: a .如果发布类型是 PATCH: from commit messages。 b .如果发布类型是次要或主要，并且最新提交是一个变更日志:使用该提交的主体作为一个变更日志。
向 npm 发布新版本。
将 changelog 发布到 GitHub 发布页面。

安装语义发布

首先安装语义发布命令行工具:

npm install -g semantic-release-cli

然后在您的项目文件夹中运行它:

semantic-release-cli setup

输入您的 npm 和 GitHub 凭据。如果你已经有一个，选择“创建 no .travis.yml ”,否则它将被覆盖。

将这几行添加到您的 travis.yml 中:

after_success:
  - npm run semantic-release
branches:
  except:
    - /^v\d+\.\d+\.\d+$/

定制语义发布

你可以用插件改变语义发布行为:检测发布类型，检查发布需求(像一个变更日志)，生成变更日志，等等。我做了一个包，里面有我需要的所有插件来支持我的工作流程。

首先安装插件:

npm install --save-dev semantic-release-tamia

然后添加到您的 package.json:

"release": {
  "analyzeCommits": "semantic-release-tamia/analyzeCommits",
  "generateNotes": "semantic-release-tamia/generateNotes",
  "verifyRelease": "semantic-release-tamia/verifyRelease"
}

运行 npm 安装和 npm 运行语义发布来测试是否一切正常。你会看到这样的东西:

semantic-release WARN pre semantic-release didn’t run on Travis CI and therefore a new version won’t be published.
semantic-release WARN pre You can customize this behavior using "verifyConditions" plugins: git.io/sr-plugins
semantic-release ERR! pre Failed to determine new version.
semantic-release ERR! pre ENOCHANGE There are no relevant changes, so no new version is released.

这很好，意味着两件事:语义发布不会发布，直到它在 CI 环境中运行，并且您没有可以发布的更改。