github action-note

github action ci/cd

每次修改都要小而精、经过可靠的测试,并随时可以上线
流水线(pipline)、YAML配置文件、运行时等,都是工具


CI/CD

CI/CD 持续集成和持续部署
continuous integration and continuous deployment

是持续验证变更并保持软件处于一种可以安全、可靠发布的状态
是一种可重复的,确保每次都能执行相同检查的软件发布过程

CI

每次推送代码,自动进行测试,并与其余代码库进行验证

  1. Code Commit
    • 开发者编写代码并推送至仓库
  2. Continuous Integration
    • 更改被自动拉取并融合
  3. Build
    • 安装依赖,编译程序,构建项目
  4. Test
    • 自动化测试确保代码质量
    • 反馈 2. Continuous Integration 阶段

CD

在通过测试后,代码将始终处于随时可以发布的状态,可以随时部署

  1. Package
    • 项目被打包为应用(如 docker image、.jar …)
  2. Deploy to Staging
    • 自动部署到环境中
  3. Deploy to Production
    • 自动部署到生产环境
  4. Monitor
    • 由系统监控应用程序的性能和故障

Github Action

Pipline 本质上只是一份自动化的核验清单,可能指示安装依赖、运行测试、部署程序等流水线过程,就是一种 顺序的 执行清单

1. 构建 CI/CD 配置目录

在项目根目录下,创建 .github 文件夹

并在其中添加 workflow 文件夹

1
.github/workflow

这是 Github Action 的指定路径

2. 创建 .yml CI/CD 工作流配置文件

YAML 只是一种以结构化格式编写配置的方法

在 <project-root-path>/.github/workflow/ 下,创建 <name>.yml 文件,其中 可以是任何你想到的名字,但是一定是 .yml 格式的文件后缀

1
<project-root-path>/.github/workflow$ touch ci.yml

3. 编写 .ymal CI 流水线

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
name: CII Pipline   # 标签,确定了在 GitHub Actions 选项卡中显示的名称

on: # 何时运行工作流,用于指定哪些事件应该触发工作流,在指定事件之一发生
push: # 推送
branches: [main] # 分支名称
pull_request: # 拉取请求
branches: [main] # 分支名称

jobs: # 任务块,是Github Action中的主要工作单元,每个人无负责一项特定的工作,并在独立的虚拟机上运行
test: # 测试任务
runs-on: ubuntu-latest # 虚拟机环境

steps: # 执行步骤,是具体命令,在虚拟机环境下执行
- name: Check out the Code # 名称,用于可读的日志输出
uses: actions/checkout@v4 # 用法,可以使用一个已经存在的 Action 复用社区资源,类似于一种自动化组建

- name: Set up xxx
uses: actions/setup-node@v4
with: # 向预构建的 Action 传递选项
node-version: '22'

- name: Install dependencies
run: npm ci # 直接在虚拟机上执行命令

- name: Run Test
run: npm test

4. 推送工作流至主分支

1
2
3
4
5
git add .github/workflow/<name>.yml

git commit -m "ci/cd: <info>"

git push

接着,可以在项目仓库中的 Action 标签下监控CI/CD产物

5. 监控 Github Action 日志

检查 Github Action 日志状态,及时进行修复

完成 CI/CD 工作流


CI/CD 实践

实践仓库:http-server — 基于 Boost.Asio / Boost.Beast 的 C++ HTTP 服务器

目标文件

文件 说明
.github/workflows/http-server-ci.yml CI 流水线:CMake 构建(Debug + Release 矩阵)、GTest 单元测试 + 集成测试、ccache 编译缓存

技术栈要点

  • 语言:C++17, CMake 3.15+
  • 依赖:Boost 1.83(system, thread, filesystem, log, program_options, json)
  • 测试:Google Test + ctest(57 用例)
  • CI 环境:ubuntu-24.04, actions/checkout@v6, actions/cache@v5 (ccache)