setting-up-ci

设置 CI（GitHub Actions）

当用户要求设置 CI、持续集成、构建流水线或 GitHub Actions 时，使用此技能。

步骤

1. 检测项目结构 — 检查是否存在 package.json（Node.js）、requirements.txt / pyproject.toml（Python）、go.mod（Go），或 Turborepo 等单体仓库工具。

2. 创建 .github/workflows/ci.yml

   对于 Node.js 项目：

   name: CI
   
   on:
     push:
       branches: [main]
     pull_request:
       branches: [main]
   
   jobs:
     build:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v4
         - uses: actions/setup-node@v4
           with:
             node-version: 20
             cache: npm
         - run: npm ci
         - run: npm run lint
         - run: npm run typecheck
         - run: npm test
         - run: npm run build
   

3. 添加类型检查 — 如果 package.json 中不存在 typecheck 脚本，则添加 "typecheck": "tsc --noEmit"。

4. 添加缓存 — actions/setup-node 的 cache 选项可缓存 node_modules。对于使用 Turborepo 的单体仓库，添加远程缓存，或使用 actions/cache 缓存 .turbo。

5. 添加矩阵测试（可选） — 如果用户需要在不同 Node 版本或操作系统上测试：

   strategy:
     matrix:
       node-version: [18, 20, 22]
   

6. 添加部署步骤（可选） — 如果用户有此要求，则添加一个仅在推送到 main 时运行，并且以构建任务成功为前提的部署任务：

   deploy:
     needs: build
     if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - run: npm ci && npm run build
       - run: npx vercel deploy --prod --token=${{ secrets.VERCEL_TOKEN }}
   

7. 添加状态徽章 — 将工作流状态徽章添加到项目 README：

   ![CI](https://github.com/OWNER/REPO/actions/workflows/ci.yml/badge.svg)
   

注意事项

• 保持 CI 快速 — 如果流水线运行较慢，则通过独立任务并行运行 lint 和类型检查。
• 使用 npm ci（而不是 npm install）来确保安装结果一致。
• 将密钥（API 密钥、部署令牌）存储在 GitHub 仓库设置中，切勿放在工作流文件中。