CI/CD / 系统课时

把代码检查和测试接入 CI

把代码检查和测试接入 CI

代码能成功提交,并不代表它满足质量要求。本节把 lint 和单元测试放进 GitHub Actions,让每次推送和 Pull Request 都自动执行相同检查,并通过失败的 Job 阻止有问题的改动悄悄进入后续流程。

学习目标

  • 配置在 push 和 Pull Request 时运行的 CI 工作流
  • 将依赖安装、lint 与单元测试组成可重复的检查链路
  • 根据 Actions 的失败步骤定位代码质量问题

把质量检查变成流水线门槛

本地执行 lint 和测试依赖开发者主动操作,很容易出现“忘记运行”或本地环境不同的问题。CI 的价值是把检查规则写进仓库:只要触发条件满足,GitHub 就创建新的工作流运行,并在隔离的 Runner 上重新安装依赖和执行检查。

典型顺序是“检出代码 → 准备运行环境 → 安装锁定依赖 → lint → 单元测试”。前面的步骤失败后,默认不会继续执行后续步骤,因此一次运行的最终状态可以直接反映这组质量检查是否通过。

提交与Pull Request触发CI质量检查流程

配置 lint 和测试 Job

以已经提供 npm run lint 和 npm test 脚本的 Node.js 项目为例,在仓库中创建 .github/workflows/ci.yml。pull_request 负责在 PR 更新时检查候选改动,push 则覆盖直接推送到 main 的场景。

yaml
name: CI

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  quality:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 22
          cache: npm

      - name: Install dependencies
        run: npm ci

      - name: Lint
        run: npm run lint

      - name: Unit tests
        run: npm test

这是完整的工作流配置示例。它依赖仓库根目录存在 package.json 和与其匹配的 package-lock.json,并且 package.json 已定义 lint 与 test 脚本。npm ci 根据锁文件执行确定性安装,比在 CI 中重新解析依赖版本更合适。

预期结果:提交一个能够通过 lint 和单元测试的改动后,Actions 中的 quality Job 成功,关键步骤表现如下;实际时间可能不同。

text
Install dependencies  ✓
Lint                  ✓
Unit tests            ✓
quality               success

用失败结果定位问题

如果 npm run lint 返回非零退出码,Lint 步骤会失败,默认情况下 Unit tests 不再执行;如果 lint 成功而测试返回非零退出码,则失败位置落在 Unit tests。因此应先查看第一个失败步骤的日志,而不是只看整个 Job 的红色状态。

例如本地复现 CI 中相同的核心检查,可以执行:

bash
npm ci
npm run lint
npm test

预期输出:三条命令都以退出码 0 结束时,本地质量检查通过;具体 lint 和测试日志取决于项目使用的工具。

text
lint: passed
tests: passed

上面的两行是结果语义示意,不要求项目真实打印完全相同的文本。真正的判断依据是命令退出码:0 表示成功,非 0 表示失败。

让 Pull Request 真正受检查约束

工作流运行成功只说明仓库已经具备自动检查能力;如果团队希望“检查失败就不能合并”,还需要在仓库规则中要求对应的状态检查通过。规则名称应与实际工作流产生的检查保持一致,修改 Job 名称后也要确认保护规则是否仍匹配。

建立 CI 后,判断标准应保持简单:开发者可以在本地运行同一组命令,GitHub Actions 在干净环境中再次验证,而 Pull Request 根据检查状态决定是否满足合并条件。这样 lint 和单元测试才从个人习惯变成仓库级质量约束。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

把代码检查和测试接入 CI

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通