lerna-changelog 使用教程

lerna-changelog 使用教程

lerna-changelog:book: PR-based changelog generator with monorepo support项目地址:https://gitcode.com/gh_mirrors/le/lerna-changelog

项目介绍

lerna-changelog 是一个基于 Pull Request (PR) 的变更日志生成器，特别支持 monorepo 项目。它能够自动检测项目中的子文件夹，并将相关的包名包含在变更日志中。此外，lerna-changelog 通过与 GitHub API 交互，可以生成详细的变更日志，帮助开发者更好地管理和追踪项目的变化。

项目快速启动

安装

首先，你需要安装 lerna-changelog：

npm install lerna-changelog --save-dev

配置

在项目的 package.json 文件中添加 changelog 配置：

{
  "changelog": {
    "labels": {
      "feature": "New Feature",
      "bug": "Bug Fix"
    }
  }
}

生成变更日志

使用以下命令生成变更日志：

npx lerna-changelog

应用案例和最佳实践

应用案例

假设你有一个 monorepo 项目，包含多个子包。你可以使用 lerna-changelog 来生成每个子包的变更日志，从而更好地管理项目的版本和变更。

最佳实践

1. 标签管理：确保每个 PR 都正确地打上了标签，这样 lerna-changelog 才能正确地分类和生成变更日志。
2. 缓存设置：为了避免 GitHub API 的限速问题，可以设置缓存目录：

{
  "changelog": {
    "cacheDir": "changelog"
  }
}

典型生态项目

lerna-changelog 通常与 lerna 一起使用，lerna 是一个用于管理 monorepo 项目的工具。通过结合使用 lerna 和 lerna-changelog，你可以更高效地管理大型项目，并自动生成详细的变更日志。

相关链接

• lerna
• lerna-changelog

通过以上步骤和实践，你可以充分利用 lerna-changelog 来提升项目管理和文档生成的效率。

lerna-changelog:book: PR-based changelog generator with monorepo support项目地址:https://gitcode.com/gh_mirrors/le/lerna-changelog