Changesets Release Action 开源项目教程

1. 项目介绍

Changesets Release Action 是一个GitHub Action，用于自动化管理你的Changesets版本发布。它可以帮助你创建包含所有更新包版本的pull request，并更新changelog。当你的配置的baseBranch上有新的changesets时，该PR将会被更新。一旦PR被合并，你可以手动发布包到npm，或者设置action自动完成发布。

2. 项目快速启动

以下是一个基本的示例，说明如何将Changesets Release Action集成到你的GitHub仓库中。

首先，在你的GitHub仓库中创建一个.github/workflows/release.yml文件，并添加以下内容：

name: Release

on:
  push:
    branches:
      - main

jobs:
  release:
    name: Release
    runs-on: ubuntu-latest

    steps:
    - name: Checkout Repo
      uses: actions/checkout@v3

    - name: Setup Node.js
      uses: actions/setup-node@v3
      with:
        node-version: '14'

    - name: Install Dependencies
      run: yarn

    - name: Create Release Pull Request
      uses: changesets/action@v1
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

这个工作流将在每次向main分支推送代码时触发。

3. 应用案例和最佳实践

案例一：自动化发布

如果你希望Changesets Action在合并PR后自动发布包到npm，你需要设置一个npm token。首先，在GitHub仓库的Settings -> Secrets中添加一个名为NPM_TOKEN的秘密，值为你的npm账号的token。

然后，更新你的.github/workflows/release.yml文件，以包括发布步骤：

    - name: Create Release Pull Request or Publish to npm
      id: changesets
      uses: changesets/action@v1
      with:
        publish: yarn publish
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

这样配置后，每当合并PR时，Changesets Action将会自动发布更新后的包。

案例二：自定义发布逻辑

如果你有自定义的发布逻辑，你可以在工作流中添加自定义步骤来处理发布。例如：

    - name: Publish
      if: steps.changesets.outputs.hasChangesets == 'false'
      run: yarn publish --new-version ${{ steps.changesets.outputs.nextVersion }}

这里，我们使用了Changesets Action的输出nextVersion来指定发布的新版本。

4. 典型生态项目

Changesets Release Action适用于任何使用Changesets来管理版本的项目。以下是一些可能使用此Action的典型生态项目：

• 任何需要自动化版本发布流程的开源项目。
• 项目拥有多个包，并且需要保持版本一致性的项目。
• 需要与GitHub Actions集成，实现持续集成和持续部署（CI/CD）的项目。

通过集成Changesets Release Action，这些项目可以简化发布流程，减少手动操作，从而提高开发效率。