如何在 github action中使用 qit commit

18 min read

要在 GitHub Action 中使用 Commitizen，可以按照以下步骤进行操作：

  1. 在项目根目录中，通过以下命令安装 Commitizen：

    npm install -g commitizen

  2. 创建一个名为 .github/workflows 的文件夹，并在其中创建一个名为 main.yml 的文件。

  3. 在 main.yml 文件中添加以下内容：

    name: CI

on:
  push:
    branches:
      - your-branch

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

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

      - name: Install dependencies
        run: npm ci

      - name: Commit changes
        run: git cz --no-verify

    注意：

    • on.push.branches 中的 your-branch 要替换为你自己的分支名。
    • uses: actions/setup-node@v2 中的 node-version 要根据你的项目的 Node.js 版本进行设置。
    • run: npm ci 是用来安装项目的依赖，如果你的项目中没有 package-lock.json 文件，可以改为 run: npm install。

  4. 提交并推送 .github/workflows/main.yml 文件到你的 GitHub 仓库中。

现在，每次在指定分支上推送代码时，GitHub Action 都会执行 Commitizen，并自动弹出交互式界面，以帮助你进行规范化的提交。