自动化工作流

定时任务上线前,先补齐时区、日志和通知规则

为一个已能手动运行的巡检脚本加上调度,并明确运行失败时该怎么办。

前置条件

已有一个能手动运行的检查脚本,并且已经验证正常、失败和超时情况。下面使用 GitHub Actions 展示调度结构;脚本检查本仓库已有文件,不需要访问生产机器。示例需要你先创建 scripts/check-links.mjs,不能直接套进没有该脚本的仓库。

写一个最小工作流

把配置保存到 .github/workflows/check-links.yml。此示例每天 08:00 UTC 触发,并保留手动触发入口;平台排队等因素可能导致延迟,它不适合精确到秒的调度需求。

yaml
name: Check documentation links
on:
  schedule:
    - cron: '0 8 * * *'
  workflow_dispatch:
permissions:
  contents: read
concurrency:
  group: documentation-links
  cancel-in-progress: false
jobs:
  check:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '22'
      - run: node scripts/check-links.mjs

Action 版本属于示例基线,实际项目按官方发布与团队策略维护,生产仓库可固定经核对的提交版本。

明确时区和运行位置

不要只写“每天早上”。用 UTC 表达这个 cron,并记录对应业务时区。夏令时切换后,本地时间可能变化。还要确认定时工作流所在的默认分支及平台当前调度规则。

保留足够的日志

每次运行记录开始、结束、处理数量与失败项。日志不要打印 token、请求认证头或完整私人数据。只有终端里的临时输出还不够,重要结果应保存在可回看的运行日志或制品中。

通知要有门槛

先使用平台已有失败提醒。自建通知时,再定义“从正常变失败”“失败恢复”“需要人工处理”等条件,并选择存储上次状态的位置。当前示例没有实现跨次状态保存或自定义通知,不应宣称具备去重功能。

验收

先手动运行一次,再检查定时运行记录;模拟脚本失败,确认能看到失败原因。若无权限或平台尚未触发,明确写成待验收事项。

官方资料与参考

产品功能与命令可能调整。遇到差异时,以对应官方页面和当前环境为准。

读完了,动手试一次。

完成练习后,标记进度,方便继续学习。

需要独立的 macOS 开发环境?

了解三万主机的远程 Mac 租赁,或先看看你是否需要一台远程 Mac。

了解三万主机 ↗