语义发布 - 向自动生成的发布说明添加更多部分

Posted 2023-02-18

【中文标题】语义发布 - 向自动生成的发布说明添加更多部分

【英文标题】：Semantic Release - Add more sections to auto-generated release notes

【发布时间】：2020-03-22 18:37:37

【问题描述】：

我刚刚为我的节点项目设置了语义发布，并使用它发布了第一个版本：

似乎只有fix 或feat 类型的提交被添加到发行说明中......我也希望能够显示improvement 类型。

有没有办法配置/添加它？ 谢谢！

【参考方案1】：

更改日志文本默认由conventional-changelog-angular 生成，并在那里确定要包含在更改日志中的提交类型。

见https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/writer-opts.js#L45

如果您想在更改日志中包含其他类型的提交，您可以创建自己的预设（基于 conventional-changelog-angular），该预设将包含所有提交类型。

或者，您可以使用支持types 选项的conventional-changelog-conventionalcommits 预设来定义新类型以及它们是否应包含在发行说明中。

你的语义发布配置是：

  "plugins": [
    ["@semantic-release/commit-analyzer", 
      "preset": "conventionalcommits",
      "releaseRules": [
        "type": "improvement", "release": "minor"
      ]
    ],
    ["@semantic-release/release-notes-generator", 
      "preset": "conventionalcommits",
      "presetConfig": 
        "types": [
          "type": "feat", "section": "Features",
          "type": "fix", "section": "Bug Fixes",
          "type": "perf", "section": "Performance Improvements",
          "type": "revert", "section": "Reverts",
          "type": "docs", "section": "Documentation", "hidden": true,
          "type": "style", "section": "Styles", "hidden": true,
          "type": "chore", "section": "Miscellaneous Chores", "hidden": true,
          "type": "refactor", "section": "Code Refactoring", "hidden": true,
          "type": "test", "section": "Tests", "hidden": true,
          "type": "build", "section": "Build System", "hidden": true,
          "type": "ci", "section": "Continuous Integration", "hidden": true,
          "type": "improvement", "section": "Improvement", "hidden": false
        ]
      
    ]
  ]

我为@semantic-release/commit-analyzer 添加了releaseRules 配置，因为我假设您想为improvement 提交创建一个次要版本。

【讨论】：

将 hidden 设置为 true 有什么意义？如果我们想要隐藏条目，为什么不直接删除它？

包含以便以后更容易重新激活@trallnag

是有意义的