GitHub Actions

在 GitHub Actions 中运行 CheckHere

CheckHere 的 ci 子命令适合在预览环境或部署完成后运行。退出码 0 表示通过当前策略,退出码 1 表示发现超出阈值的问题,退出码 2 表示执行环境错误。

最小工作流

官方 Action 会安装 v0.4.0、准备 Chromium、运行检查,并把报告保存在当前 workflow 中。

name: checkhere
on: [pull_request]
jobs:
  browser-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: Ryan-yang125/checkhere@v0.4.0
        with:
          url: https://preview.example.com
          fail-on: critical

选择失败策略

critical 适合作为第一阶段门槛。积累几次真实项目结果后,可以增加总分或单页得分阈值。

  • --fail-on=critical:发现 critical 问题时失败
  • --fail-on=score:90:总分低于 90 时失败
  • --fail-on=page-score:80:任一已检查页面低于 80 时失败

检查多个明确路由

把重要路径按行写入 routes.txt,再通过 --routes 传入。登录页、定价页、文档页和主要转化页可以获得稳定覆盖。

/
/pricing
/docs
/contact

checkhere ci https://preview.example.com --routes routes.txt --fail-on=page-score:80

保留报告证据

CI 生成的 HTML、Markdown 和 JSON 文件可以作为 workflow artifact 保存。出现失败时,团队可以直接查看截图和机器可读证据。

常见问题

CheckHere GitHub Action 需要 API key 吗?

本地 CLI 在 GitHub runner 中直接运行,基础检查无需 CheckHere 账号或 API key。

应该检查生产站还是预览站?

优先检查每个 PR 的预览地址,并在正式部署后增加一次生产冒烟检查。