GitHub Actions 流水线实战:CI/CD 从入门到优化
最近在把一个业余项目正式接入持续集成,前前后后调了差不多两周 GitHub Actions,从最开始只会复制别人的 workflow 模板,到后来能根据自己的项目形态独立设计出构建、测试、部署一整套流水线,中间踩了不少坑,也理顺了很多之前一知半解的概念。趁这两天刚把最后一个部署脚本调稳,赶紧把这份 CI/CD 学习笔记整理出来,给同样准备上手 GitHub Actions 的朋友做个参考。
这篇文章不是官方文档的翻译,也不是那种“从入门到精通”的泛泛而谈。我会以 Node.js 应用为例,从工作流的基本概念讲起,带着你一步一步写出一份能真正跑通的 workflow 文件,再把权限配置、密钥管理、缓存优化、矩阵构建这些实战中绕不开的细节逐个拆开聊。无论你是想在开源项目里跑测试,还是想给公司内部项目做自动化部署,这篇文章应该都能给你一些直接的启发。
1. 为什么是 GitHub Actions:CI/CD 工具选型背后的取舍
刚接触 CI/CD 的时候,很多人的第一反应可能是:“我直接在服务器上跑脚本不行吗?为什么要引入一套这么复杂的系统?” 这个问题我在最开始也反复问过自己。后来真正体会到持续集成的价值,是在一次代码合并事故之后——某个改动把依赖环境里的一个隐式配置破坏了,测试在本地是绿的,合并到主干后整个服务直接起不来,等到用户反馈才发现问题。如果有自动化流水线,这种基础错误在合并前就能被机器直接拦住。
CI/CD 的核心就两句话:持续集成(Continuous Integration) 是频繁地把代码合并到主干,并自动运行编译和测试,确保每一次合并都是可靠的;持续交付/部署(Continuous Deployment) 则是把通过测试的构建产物自动发布到测试环境乃至生产环境,减少人工操作的介入。自动化流水线存在的意义,不是让你变得更忙,而是把“人容易出错”的环节交给机器,把“人需要判断”的部分留给你自己。
接着说工具选型。现在市面上主流的 CI/CD 工具很多,老牌的有 Jenkins,生态成熟但自建和维护成本不低;GitLab CI 和 GitLab 仓库集成度高,适合团队自建 GitLab 的情况;GitHub Actions 则是直接长在 GitHub 仓库里,对于代码托管在 GitHub 上的项目来说,天然省掉了一堆对接成本。
我选 GitHub Actions 的核心原因有三个:
- 零额外的服务端成本:不需要单独部署 CI 服务器,GitHub 托管的 runner 帮你把构建环境跑起来,你只需要写 YAML 配置文件。
- 内置的生态极其丰富:GitHub Marketplace 上有大量现成的 action,缓存、部署、通知、安全扫描,几乎每个常见需求都能找到开源实现。
- 和 Pull Request 深度集成:可以在 PR 页面上直接看到检查结果,管理员可以设置“必须通过 CI 才能合并”,这是很多团队最看重的协作体验。
当然,它也有自己的短板。给私有仓库分配的免费构建时长为每月 2000 分钟,自定义 runner 虽然有更高配额和灵活度,但需要自己维护。另外,第三方 action 的使用也需要谨慎,万一某个上游 action 被植入恶意代码,影响面会非常大。这部分我会在后面的章节里专门展开。
如果你主要用 GitLab 托管代码,那 GitLab CI 的 Pipeline 其实也很值得研究,核心的构建、测试、部署模型和 GitHub Actions 非常相似。工具只是载体,理解一套 CI/CD 的通用方法论,再迁移到具体平台,会轻松很多。
2. 先摸清 GitHub Actions 的“零件”:workflow、job、step、action
GitHub Actions 最让人上头的部分,是用 YAML 描述一套自动化流程。但很多新手一上来就复制别人的 YAML,里面的字段看不太懂,出了问题更不知道怎么调。这个感觉我太熟悉了——所以先不急着写复杂配置,我们需要把组成这套系统的基本零件拆开看清楚。
一个 workflow 是最顶层的概念,对应 /.github/workflows/ 目录下的一个 YAML 文件。它定义了整条流水线的对象:什么时候触发、在什么机器上跑、要执行哪些任务。一个 workflow 里可以包含多个 job,job 之间可以有依赖关系,也可以并行执行。每个 job 里则是按顺序执行的一个或多个 step,step 是真正干活的单元,负责运行一条命令或调用一个 action。
这里用生活里的场景来类比:workflow 是一条完整的生产流水线;job 是流水线上的某个工位,比如“安装依赖”“跑测试”都可以是独立的 job;step 是某个工位上的具体动作,比如“拉取代码”“执行 npm test”。多个工位可以同时工作(并行 job),也可以前后衔接(串行 job)。
action 则是 GitHub Actions 里的“可复用功能模块”,你可以把它理解为积木。官方和社区提供了大量 action,比如 actions/checkout 用来把代码拉取到 runner 上,actions/setup-node 用来安装指定版本的 Node.js。写 workflow 的时候,大部分工作其实是在挑选和组合这些积木。
看一个最基本的 workflow 示例,这也是我最早跑通的第一个版本:
拆开来看:name 只是给你的 workflow 起个名字,显示在仓库的 Actions 标签页里。on 定义了触发条件,这里写的是 main 分支上的推送和 Pull Request。jobs 下面是具体任务,build 是我给这个 job 起的名字,runs-on 指定了运行环境,用的是 GitHub 托管的 Ubuntu 虚拟机。steps 数组里每个元素就是一个步骤,uses 表示调用某个公开 action,run 表示直接执行 shell 命令。
这个文件第一次跑通过的时候,我对 CI 的直观感觉有了质的改变。原来“机器自动执行命令”没那么玄乎,它就是按顺序在黑盒子里跑脚本,然后把结果反馈到 GitHub 的界面上。只不过它帮你准备好了操作系统、网络环境和各种预装软件,还帮你把代码和密钥都安全地放到了指定位置。
这里必须多说一句:每个 job 默认是在完全独立的全新环境中运行的,上一个 job 里装的东西、改的文件,下一个 job 里不存在。想要在 job 之间传递数据,需要借助 actions/upload-artifact 和 actions/download-artifact 这类 action。这是新手最容易踩的坑,并不是在同一个“服务器”上连续操作。
3. 动手实战:为 Node.js 应用搭建构建-测试-部署流水线
概念理清楚之后,就该动真格的了。我们以一个比较典型的 Node.js/Express 项目为例,目标是让它经历三段旅程:安装依赖与代码规范检查 → 自动化测试 → 构建部署产物并发布到服务器。这个流程覆盖了大多数中小团队的真实需求。
3.1 设计流水线前,先理解项目的“检查点”
写 workflow 之前,我建议你先打开项目,问自己三个问题:项目需要用什么工具链?哪些操作可以并行?哪些步骤失败后需要阻断合并或发布?以 Node.js 项目来说,通常有这几类操作:
- 使用
npm ci安装依赖(区别于npm install,npm ci严格依据 lock 文件安装,保证可复现,且速度更快); - 运行代码规范检查,比如 ESLint,提前拦截风格和潜在逻辑问题;
- 运行单元测试或集成测试,这是 CI 的核心价值所在;
- 如果项目要对外发布,可能还需要构建静态文件或 Docker 镜像并推送到镜像仓库。
对于一个小型项目,把这些操作放进同一个 job 顺序执行是最省事的,但为了体现 GitHub Actions 的并行能力,我通常会拆成两个 job:一个专跑静态检查和测试,一个负责构建部署。测试 job 通过后,部署 job 再在依赖它的基础上运行。
3.2 编写第一版完整的 workflow
下面是这个实战项目最终使用的 workflow 精简版。我删掉了项目里那些个性化配置,保留了关键骨架,你可以直接作为模板使用。
这里有几个关键的设计决策,我想重点说一下“为什么”。
矩阵构建(matrix):我让测试 job 同时跑 Node.js 18 和 20 两个版本,因为代码在本地用的版本可能和别人不一样,多版本验证能提前发现兼容性问题。GitHub Actions 的 strategy.matrix 会自动展开成多个并行 job,互不干扰。
依赖缓存 cache: 'npm':这是 setup-node 自带的一个隐藏能力,会自动缓存 ~/.npm 目录。看上去只是少下载了一些包,但对运行时长的影响非常明显。在我这个项目里,启用缓存后安装依赖从 1 分多钟降到了 20 秒以内。后面我会专门讲缓存原理。
部署条件 if:build-and-deploy job 只在 main 分支的 push 事件里运行,Pull Request 的检查不会触发部署。这是最基本的“环境隔离”意识,测试归测试,发布归发布,不要混在一起。
appleboy/scp-action:这是一个非常流行的第三方 action,用来把本地文件通过 SSH 拷贝到远程服务器。你也可以直接使用更底层的 ssh-action 在服务器上执行命令,完成打包下载、重启服务等操作。
3.3 如何把 Node 应用安全地部署到服务器
上面用 scp 直接把构建产物上传到服务器,对静态站点够用了。但如果是 Node 服务,还需要处理进程重启的问题。我在实际项目中是这么做的:上传完之后,追加一个 step,用 SSH 登录服务器,执行项目的重启脚本。
pm2 reload 是一个优雅的进程重启方式,它先创建新的工作进程,等新进程监听成功后,再杀掉旧进程,能最大程度减少服务中断时间。如果不使用 pm2,你也可以在脚本里用 systemctl restart myapp,前提是你的服务器配置了 systemd 服务。
这套流程跑通后,你推送代码到 main 分支,一两分钟内就能看到测试自动执行、服务自动更新,这种反馈对人的信心提升真的很大。
4. 部署环节的坑:权限、密钥管理与环境变量注入
很多人写完 workflow 推到 GitHub,发现跑是能跑,但一到部署那一步就开始报各种摸不着头脑的错误。我在这上面栽的跟头最多,现在把最关键的几个问题拿出来说说。
4.1 GITHUB_TOKEN 的权限边界
GitHub Actions 每次运行时都会自动创建一个 GITHUB_TOKEN,它是一个专用令牌,用来让 runner 在仓库内执行操作,比如读取代码、创建 issue、提交评论。它在 workflow 里通过 ${{ secrets.GITHUB_TOKEN }} 访问。权限受仓库设置和 workflow 顶部 permissions 字段的控制。
我在一个比较早的项目里,需要 workflow 往仓库里推送编译后的文件,但每次 push 都报 Permission denied。折腾了很久才发现,是工作流没有声明 contents: write 权限,而默认的 GITHUB_TOKEN 权限是只读的。解决办法是在 workflow 顶部加上:
这里要提醒一句:给权限的时候一定要按最小化原则拆开写,不要直接无脑写 permissions: write-all。比如只是要在 PR 里发一条评论,那就 issues: write;只是要读取代码,那就 contents: read。权限放太宽,一旦 workflow 里的某个第三方 action 被攻破,攻击者就能直接改写你的仓库内容。
4.2 Secrets 不是字面意义上的“密文”
GitHub 仓库的 Settings -> Secrets and variables 里可以配置 Actions secrets,在 workflow 中通过 ${{ secrets.NAME }} 引用。但这和本地环境变量有个非常重要的差异:如果你把一个 secret 直接拼接到 shell 命令或输出中,GitHub 的长日志保护机制会尝试自动打码,但并不是所有情况都能覆盖到。 尤其是当你把 secret 写进一个 JSON 文件、Base64 编码串或者 URL 参数时,日志里很容易留下痕迹。
比较稳妥的做法是把 secret 作为单独的环境变量传给 action:
这样在 run 内部通过 $TOKEN 引用,日志中不会直接展示值。另外,run 里如果使用了 set -x 或者 echo "TOKEN=$TOKEN",依然会泄露,所以调试部署脚本时一定记得关闭这类输出。
4.3 SSH 密钥部署的标准姿势
使用 appleboy/scp-action 或 appleboy/ssh-action 时,需要在 GitHub Secrets 中保存这几个值:服务器 IP(SERVER_HOST)、用户名(SERVER_USER)、私钥内容(SSH_PRIVATE_KEY)。私钥必须是无密码(passphrase为空)或者使用 ssh-agent 方式处理,否则 CI 环境中无法交互式输入密码,会直接卡死。
一个实用的建议:在服务器上单独创建一个 deploy 用户,只给它的 authorized_keys 添加密钥,并限制它只能访问指定目录和命令。不要在 CI 里使用 root 用户的密钥,这和本地开发时的安全习惯是一样的。比如在服务器上执行:
之后 workflow 里就用 deploy 身份去操作,配合 sudo 命令做提权时,记得在 script 里写成 sudo -n 防止交互式提示。这一套做下来,比直接把 root 密钥交给第三方 action 安全得多。
4.4 环境变量注入的另一个细节
同一个 secret 在不同环境下可能值并不相同。我经常在 GitHub Actions 里手动定义环境级别:
environment: production 可以关联到仓库的 Environments,你可以在那里配置特定环境的 secrets、保护规则甚至人工审核。这意味着你可以把测试环境和生产环境的密钥分开管理,避免全部塞在同一层里。对于多人协作的项目,这个功能非常值得用起来,生产环境部署前还可以加上一个手动确认的按钮。
5. 让流水线更快更稳:缓存、矩阵构建与并发控制
流水线跑通了只是第一步,接下来面对的是性能问题和多分支并发问题。一个跑了十几分钟的流水线,会让你越来越不想看它;一个在合并 PR 前排队半个小时的 CI,会让团队异常痛苦。所以当基础流程稳下来后,一定要回头做优化。
5.1 依赖缓存的原理与实操
GitHub Actions 为每个仓库分配了一块缓存空间,我们可以把 npm、pip、Maven 等依赖下载缓存下来,后续运行直接复用。以 npm 为例,npm ci 之前会校验 package-lock.json 的缓存 key 是否变化,如果没变化,它就不需要重新解析依赖树了,直接从本地缓存安装。
实践里最简单的方式就是在 actions/setup-node 里声明 cache: 'npm'。我测试过三种配置的耗时对比:
| 配置方式 | 首次运行耗时 | 后续运行耗时 |
|---|---|---|
| 无缓存 | 约 110 秒 | 约 110 秒 |
| 手动 cache action | 约 95 秒 | 约 25 秒 |
| setup-node cache 自动 | 约 100 秒 | 约 22 秒 |
手动 actions/cache 的通用性更强,如果你用 pnpm 或 Yarn,写法会不太一样。比如 pnpm 的缓存路径是 ~/.pnpm-store,需要在 setup-node 之前先安装 pnpm,再用 actions/cache 缓存这个路径。
有一点需要特别留意:缓存 key 的颗粒度要设计好。如果 key 包含 lock 文件的哈希,那么依赖变化时缓存会失效,重新获取依赖;如果 key 不包含任何指纹,那缓存可能长时间不更新,导致装出来的依赖版本和 lock 文件不一致。我常用的 hash 方式:
restore-keys 配置的意义在于:即使 lock 文件变了,也能尽量复用之前相近的缓存,至少不用从零下载全部依赖。
5.2 矩阵构建不只是“多版本测试”
矩阵构建最常见的用途确实是多 Node.js 版本或多操作系统测试,但它还能用在更实际的地方,比如按模块拆分测试任务。如果你的项目测试用例非常多,一个 job 跑完要 20 分钟,完全可以把测试文件按目录切分成几个 shard,并行跑:
这样每个 job 只跑总测试集的四分之一,总耗时从 20 分钟降到 6 分钟左右。对于大型项目,这种“分片”策略比单纯买更强的机器更实际,而且 GitHub Actions 的并行 job 数在免费额度内是足够的。
5.3 concurrency:防止重复部署和资源浪费
这是一个很容易被忽略的点。当开发者连续往 main 分支推送 3 次提交时,默认情况下 GitHub Actions 会启动 3 个并行的 workflow 运行。可是部署类 job 往往带有副作用——前一个还没部署完,后一个又开始部署了,很容易出现服务短暂不可用,甚至旧版本又把新版本覆盖回去的混乱。
解决办法是在 workflow 顶层声明 concurrency:
group 是把同一分支的多个运行归到同一组;cancel-in-progress: true 表示新运行开始后,自动取消该组内还没结束的旧运行。这个策略对文档站、静态站点部署特别重要,既能避免并发冲突,还能省下不少 Action 运行分钟数。
我个人习惯是在“测试类”workflow 里不设置 cancel-in-progress,因为 PR 上多个提交的测试结果需要完整跑完,方便看到每次提交的真实情况;而在“部署类”workflow 里一定设置。场景不同,策略不能一概而论。
5.4 失败重试和超时设置
CI 偶尔会有网络超时、npm 源抽风等暂时性错误。如果不做任何设置,一次失败就判定整个 job 失败,有时挺冤枉的。GitHub Actions 支持在 step 级别配置 continue-on-error 也可以配置 timeout-minutes,但更实用的做法是借助 retry 相关 action,比如 nick-fields/retry:
不过要注意,重试逻辑不能滥用。如果命令本身是确定性失败的,重试只会延迟失败的反馈时间。我通常只对“网络下载类”操作做重试,测试失败则必须立刻暴露给开发者。
6. 学习 GitHub Actions 时最容易走的弯路
最后这部分,是我自己在学习和使用 GitHub Actions 过程中总结出来的一些容易走偏的地方。不一定每个都对应官方文档,但都是从实际报错和改配置里得来的教训。
6.1 照搬他人 workflow,不读版本
GitHub Actions 生态更新非常快,不同 action 的 major 版本之间接口可能不兼容。最典型的是 actions/checkout@v2 和 actions/checkout@v4,在文件权限、自动 token 行为上都有差异。很多你在网上搜到的教程可能已经过时,照着写后报错却不知为何。
我的建议是:使用 action 时务必锁定主版本号,比如 @v4,并养成在报表页面看官方 README 和 release notes 的习惯。如果项目对稳定性要求很高,甚至可以锁定到完整 commit SHA,形式如 actions/checkout@a12c4b...,这样就彻底杜绝了上游 action 被篡改的风险——GitHub 官方也推荐这种做法。
6.2 workflow 文件膨胀后,难以调试
一个 YAML 文件从 30 行涨到 300 行之后,任何改动都提心吊胆。我在一个稍微复杂的项目里,workflow 里塞了十多个 step,其中一个 step 名字写错了,只能在日志里一行行找。后来我学会把重复的步骤抽到 composite action 中,也就是在 .github/actions/ 目录下新建自定义 action,把“安装依赖并缓存”“执行 lint”这类通用逻辑封装成单块积木。这样 workflow 文件会变得非常简洁,排错时也只需要打开对应的 action 文件。
6.3 过度依赖第三方 action 的安全隐患
Marketplace 上的 action 种类多,用起来方便,但你必须意识到:第三方 action 可以访问 runner 的文件系统、环境变量以及 GITHUB_TOKEN。如果你的仓库是私有仓库,代码泄露风险更大;如果是开源项目,也要警惕恶意 PR 利用某些 action 的漏洞。
为了降低风险,我有三个习惯:
- 锁版本(用 tag 或 commit SHA);
- 尽量使用 star 多、维护活跃的 action;
- 审查 action 的源码,尤其是那些比较小众的。GitHub 上每个 action 都是仓库,花十分钟看一下它的主脚本没有坏处。
6.4 把 CI 当成“另一个测试环境”
最开始我总喜欢在 workflow 里跑各种临时命令,手动验证这个那个。这其实扭曲了 CI 的本意。CI 应该服务于固定的检查流程,而不是一个玩具终端。如果你发现自己经常 login 到 runner 上手敲命令,大概率是流程设计有问题。真正需要临时调试的时候,可以启用 workflow_dispatch 触发的调试 job,但完事之后要记得删掉,不能一直留在工作流里。
6.5 忽略日志中的敏感信息
我已经不止一次在日志里看到别人把密码、API Key、甚至私钥直接打印出来。GitHub Actions 虽然有 secret mask 机制,但只要你把一个 secret 塞进某个变量再以另一种形式打印,比如 Base64 编码、URL 编码、替换了几个字符拼出来,mask 就不一定能识别了。最稳妥的方法是在 workflow 里加一个“自毁式”检查:部署完成后,用 grep 检查日志中是否包含任何不应出现的关键字,一旦命中就直接让 job 失败。这虽然不能完全防止泄露,但至少能提供一个拦截点。
6.6 学习路径上的建议
如果你想系统地学 GitHub Actions,我个人的建议路径是:先跑通官方快速上手教程,再用自己的一个小项目写一份最简单的 workflow;接着引入一个第三方 action 完成一件事,比如自动发布 Release;之后再逐步加上矩阵、缓存和部署。切忌一上来就复制庞大的多环境发布模板,那样你只会得到一个“能跑但没看懂”的黑盒子,问题来了完全无从下手。
现在回想起来,从最初把 CI/CD 当作“添加一个 YAML 文件”的任务,到现在能根据项目形态去灵活设计流水线的触发条件、任务拆分、权限控制,这个过程的核心收获并不是某个命令或某个 action 的用法,而是养成了一种“自动化优先”的思维习惯:任何重复的事情,先考虑能不能在代码层面给它一个规则;任何手动操作,先问自己它能不能被机器验证。
最后再分享一个小技巧:在 workflow 的 job 名或 step 名里加上当前分支或版本号,比如 Deploy main - ${{ github.sha }},这样部署日志里一眼就能看出对应的是哪次提交,免去来回翻代码历史的时间。这种细节平时不起眼,真正出问题排查的时候,能救命的往往就是这些小事。