Changesets Release Action 项目启动与配置教程

1. 项目的目录结构及介绍

Changesets Release Action 是一个用于自动化管理版本发布和更新 changelog 的 GitHub Action。项目的目录结构如下：

• .changeset：存放更改集文件的目录。
• .github：包含 GitHub Actions 工作流的目录。
• __fixtures__：用于测试的固定数据目录。
• scripts：包含项目脚本文件的目录。
• src：源代码目录，包含项目的核心功能。
• types：类型定义文件目录。
• gitignore：Git 忽略文件，指定 Git 应该忽略的文件和目录。
• LICENSE：项目许可证文件。
• README.md：项目自述文件，介绍项目的相关信息。
• action.yml：GitHub Action 的配置文件。
• package.json：Node.js 项目配置文件。
• rollup.config.js：Rollup 打包配置文件。
• tsconfig.json：TypeScript 配置文件。
• yarn.lock：Yarn 锁文件，确保项目依赖的一致性。

2. 项目的启动文件介绍

项目的启动主要通过 GitHub Actions 工作流来实现。以下是一个简单的启动工作流示例：

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: '20'
      - name: Install Dependencies
        run: yarn
      - name: Create Release Pull Request
        uses: changesets/action@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

这个工作流会在每次 main 分支有 push 操作时触发，执行以下步骤：

• 检出代码库。
• 设置 Node.js 环境。
• 安装依赖。
• 创建一个包含版本更新和 changelog 的 pull request。

3. 项目的配置文件介绍

项目的配置主要通过 package.json 和 GitHub Actions 工作流文件中的 action.yml 来进行。

package.json

package.json 文件包含了项目的依赖、脚本和元数据。例如：

{
  "name": "changesets-action",
  "version": "1.0.0",
  "scripts": {
    "release": "changeset publish"
  },
  "dependencies": {
    // 项目的依赖列表
  }
}

在这个文件中，你可以定义项目的启动脚本，例如上面的 release 脚本用于发布版本。

action.yml

action.yml 文件用于配置 GitHub Action 的输入参数。例如：

inputs:
  publish:
    description: 'The command to use to build and publish packages'
    required: false
  version:
    description: 'The command to update version, edit CHANGELOG, read and delete changesets'
    default: 'changeset version'
  commit:
    description: 'The commit message to use'
    default: 'Version Packages'
  # 其他输入参数...

在这个文件中，你可以定义输入参数的描述和默认值，以便在 GitHub Actions 工作流中使用。