发布说明生成器

semantic-release 插件，使用 conventional-changelog 生成变更日志内容

安装

$ npm install @semantic-release/release-notes-generator -D

使用

插件可以在 semantic-release 配置文件 中进行配置：

{
  "plugins": [
    [
      "@semantic-release/commit-analyzer",
      {
        "preset": "angular",
        "parserOpts": {
          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
        }
      }
    ],
    [
      "@semantic-release/release-notes-generator",
      {
        "preset": "angular",
        "parserOpts": {
          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
        },
        "writerOpts": {
          "commitsSort": ["subject", "scope"]
        }
      }
    ]
  ]
}

使用此示例：

• 在提交消息正文中包含 BREAKING CHANGE、BREAKING CHANGES 或 BREAKING 的提交将被视为破坏性变更（默认情况下，angular 预设 仅检查 BREAKING CHANGE 和 BREAKING CHANGES）
• 变更日志中的提交将按 subject 然后按 scope 排序（默认情况下，angular 预设 在变更日志中按 scope 然后按 subject 对提交进行排序）

配置

选项

注意：config的值将被preset的值覆盖。你应该使用preset或config中的一个，而不是同时使用两者。

注意：parserOpts和writerOpts的个别属性将覆盖通过显式设置的preset或config加载的属性。如果未设置preset或config，则只会使用parserOpts和writerOpts中设置的属性。

注意：对于需要配置对象的预设，如conventionalcommits，必须设置presetConfig选项。