semantic-release插件：release-notes-generator使用手册

semantic-release插件：release-notes-generator使用手册

release-notes-generator:clipboard: semantic-release plugin to generate changelog content with conventional-changelog项目地址:https://gitcode.com/gh_mirrors/re/release-notes-generator

---

项目介绍

release-notes-generator是专为semantic-release设计的一个插件，旨在自动生成符合conventional-changelog规范的变更日志内容。通过解析提交消息，它能够智能地区分不同类型的更改，如特性添加、修复以及重要的破坏性变更，并以结构化的方式呈现这些变更，从而简化版本发布过程中的文档工作。

项目快速启动

要开始使用release-notes-generator，您首先需确保您的项目已配置了semantic-release。以下是快速集成此插件的步骤：

安装插件

在您的项目根目录下执行以下npm命令来安装@semantic-release/release-notes-generator：

npm install --save-dev @semantic-release/release-notes-generator

配置semantic-release

接着，在您的项目中创建或更新.semantic-release.json或package.json文件的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”关键词的提交被识别为破坏性变更，且保证生成的日志中的提交按主题和范围排序。

触发 Semantic Release

配置完成后，您可以通过CI/CD流程或本地运行npx semantic-release来触发自动化的版本发布和变更日志生成。

应用案例和最佳实践

• 自动化版本管理：结合CI/CD工具（如GitHub Actions），每次合并到主分支时自动分析提交、生成变更日志并发布新版本。
• 团队协作：确保所有团队成员遵循提交约定，以便正确地被分类和记录。使用工具如commitizen辅助规范化提交。
• 历史追溯：利用详细的变更日志，方便后期查找特定功能的引入或bug的修复时间点。

典型生态项目

虽然直接关联的“典型生态项目”信息未在提供材料中明确提及，但可以理解，semantic-release及其相关插件，如release-notes-generator，广泛应用于现代JavaScript项目中，特别是在那些追求高度自动化版本管理和文档维护的开源项目及企业级应用之中。例如，任何采用AngularJS、React、Vue等前端框架，并实施Git流和语义版本控制策略的项目，都可能从这类工具中获益，实现无缝的版本迭代和清晰的发布记录。

---

以上内容基于提供的资料制作而成，旨在指导如何使用release-notes-generator进行版本注释的自动化生成。在实际应用中，请参考最新官方文档以获取更详细和最新的信息。

release-notes-generator:clipboard: semantic-release plugin to generate changelog content with conventional-changelog项目地址:https://gitcode.com/gh_mirrors/re/release-notes-generator