Release Please 使用教程

1. 项目介绍

Release Please 是一个由 Google 开源的项目，旨在自动化生成 CHANGELOG、创建 GitHub 发布版本以及为项目进行版本号更新。它通过解析 Git 历史记录中的 Conventional Commit 消息来实现这些功能。Release Please 不会处理包管理器的发布或复杂的分支管理，而是专注于维护 Release PRs（Pull Requests），这些 PRs 会在合并时自动更新 CHANGELOG 文件、版本号，并创建 GitHub 发布版本。

2. 项目快速启动

2.1 安装 Release Please

首先，确保你已经安装了 Node.js 和 npm。然后，通过 npm 安装 release-please：

npm install release-please --save-dev

2.2 配置 Release Please

在你的项目根目录下创建一个 release-please-config.json 文件，并添加以下内容：

{
  "release-type": "node",
  "packages": {
    "path/to/your/package": {
      "release-type": "node"
    }
  }
}

2.3 创建 GitHub Action

在你的项目中创建一个 .github/workflows/release-please.yml 文件，并添加以下内容：

name: Release Please
on:
  push:
    branches:
      - main
jobs:
  release-please:
    runs-on: ubuntu-latest
    steps:
      - uses: google-github-actions/release-please-action@v4
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          config-file: release-please-config.json

2.4 提交并推送

提交你的更改并推送到 GitHub：

git add .
git commit -m "chore: setup release-please"
git push origin main

3. 应用案例和最佳实践

3.1 自动化版本发布

Release Please 可以帮助你自动化版本发布流程。每次你合并一个带有 Conventional Commit 消息的 PR 时，Release Please 会自动创建一个新的 Release PR，并在合并时更新 CHANGELOG 和版本号。

3.2 多包管理

如果你的项目包含多个包（例如 monorepo），你可以在 release-please-config.json 中为每个包配置不同的发布策略。

{
  "release-type": "node",
  "packages": {
    "path/to/package1": {
      "release-type": "node"
    },
    "path/to/package2": {
      "release-type": "python"
    }
  }
}

3.3 自定义发布流程

你可以通过配置 release-please-config.json 来定制发布流程，例如指定不同的发布类型、路径等。

4. 典型生态项目

4.1 Google Cloud SDK

Google Cloud SDK 使用 Release Please 来自动化其版本发布流程，确保每次更新都能及时发布到 GitHub 并更新相关文档。

4.2 Angular

Angular 项目也采用了 Release Please 来管理其版本发布，确保每次新功能的发布都能自动生成 CHANGELOG 和版本号。

4.3 TensorFlow

TensorFlow 使用 Release Please 来管理其多个子项目的版本发布，确保每个子项目都能独立发布并更新版本号。

通过以上步骤，你可以轻松地将 Release Please 集成到你的项目中，实现自动化版本发布和管理。