GitHub Actions 工作流 - 码剑客

GitHub Actions 工作流模板:触发条件与 job 结构、Node 构建测试与依赖缓存、Docker 镜像推送、制品上传与 SSH 部署、矩阵构建、最小权限与 secrets 使用。

actions/checkout@v4 / setup-node@v4更新于 2026-10-30共 22 条

基础结构

指定触发方式:分支推送、PR 与手动触发;文件需放在 .github/workflows 下

name: ci
on:
  push:
    branches: [main]
  pull_request:
  workflow_dispatch:

job 与 step 的最小结构,steps 顺序执行,任一 step 失败即中断 job

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: echo "hello"

工作流级与 job 级环境变量,job 级会覆盖同名变量

env:
  NODE_ENV: test
jobs:
  build:
    env:
      CI: true

指定 Node 版本并开启依赖缓存,缓存键基于 lockfile 自动计算

      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm

CI 中用 npm ci 保证与 lockfile 完全一致,比 npm install 更可复现

      - run: npm ci
      - run: npm run lint
      - run: npm test

构建与测试

用 .nvmrc 固定版本,避免 CI 与本地 Node 版本不一致

      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version-file: .nvmrc
          cache: npm
      - run: npm ci
      - run: npm run build

矩阵构建并行验证多个版本,fail-fast: false 可看到全部失败项

    strategy:
      fail-fast: false
      matrix:
        node: [18, 20, 22]

以非交互模式运行测试;vitest 使用 --run,jest 使用 --ci

      - run: npm test -- --run
        env:
          CI: true

无论成功失败都上传测试报告,便于定位失败原因

      - uses: actions/upload-artifact@v4
        if: always()
        with:
          name: test-report
          path: coverage/

依赖高危漏洞扫描,可按需改为 continue-on-error 先观察

      - run: npm audit --audit-level=high

镜像构建与推送

登录镜像仓库,GITHUB_TOKEN 需要 packages: write 权限

      - uses: docker/login-action@v3
        with:
          registry: ghcr.io
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}

用 commit SHA 作为标签,天然可追溯且不会覆盖历史镜像

      - uses: docker/build-push-action@v6
        with:
          context: .
          push: true
          tags: ghcr.io/${{ github.repository }}:${{ github.sha }}

启用 BuildKit 与多平台构建能力,需要多架构镜像时先执行

      - uses: docker/setup-buildx-action@v3

显式声明最小权限,默认权限收紧后避免 workflow 因缺权限失败

permissions:
  contents: read
  packages: write

产物与部署

保存构建产物,供后续 job 或人工下载;注意 v4 同名产物不可重复上传

      - uses: actions/upload-artifact@v4
        with:
          name: dist
          path: dist/
          retention-days: 7

在部署 job 中取回产物,避免重复构建

      - uses: actions/download-artifact@v4
        with:
          name: dist
          path: dist

通过 SSH 同步产物;私钥放 secrets,落盘前用 ssh-agent 或临时文件加载

      - name: Deploy
        run: rsync -avz --delete dist/ deploy@10.0.0.12:/opt/app/
        env:
          SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}

environment 可配置人工审批,concurrency 保证同一环境不并发部署

    environment:
      name: production
      url: https://app.example.com
    concurrency:
      group: production
      cancel-in-progress: false

缓存与安全

按依赖文件哈希缓存,依赖变更时自动失效

      - uses: actions/cache@v4
        with:
          path: ~/.cache/pip
          key: pip-${{ hashFiles('requirements.txt') }}

checkout 默认只取 1 个提交,需要 tag 或 diff 时把 fetch-depth 设为 0

        with:
          fetch-depth: 0

secrets 不会打印明文,可用长度校验确认是否注入成功

      - run: echo "token length ${#TOKEN}"
        env:
          TOKEN: ${{ secrets.API_TOKEN }}

为 job 与 step 设置超时,避免卡死消耗额度

    timeout-minutes: 15
    steps:
      - run: npm run test:e2e
        timeout-minutes: 10

本网站使用 Cookie 以确保您在我们的网站上获得最佳体验。 隐私政策.