初见 GitHub Actions

为什么需要 CI/CD

CI/CD 是持续集成（Continuous Integration）和持续交付（Continuous Delivery）的缩写，是一种软件开发实践，通过自动化的软件流程来构建、测试、发布软件。尽管我只是一个业余的开发者，但是也不免遇到这样的场景：

• 你现在看到的博客站点，原本是由我在本地构建后上传 GitHub 进行部署的，需要等待构建完成后再进行上传，不仅繁琐，而且还可能因为网络原因出错。
• 写了一个简单的爬虫脚本，希望能够定期运行，但是要么没有服务器，要么懒得配置 cron 任务。
• 写了跨平台的程序或者库，但是需要对应平台的运行环境才能构建，比如 Windows 下的 exe 程序，Linux 下的 so 库，Mac 下的 dmg 程序，手头又没有所有的环境。
• 或者更常见一点，写了一个简单的 Python 包，想要在每次 push 之后自动运行测试，或者在版本号更新后自动构建并上传到 PyPI。

这类的需求就非常适合 CI/CD 来解决，通过 GitHub Actions，我们可以在 GitHub 上进行持续集成和持续交付，而不需要自己搭建服务器或者配置 cron 任务。

GitHub Actions 核心思想

GitHub Actions 的核心思想是：事件驱动。类似于为当前仓库添加一系列的钩子，当触发了某个事件时，就会执行相应的操作，也就是一个工作流 workflow。

触发事件

GitHub Actions 支持的事件非常多，概括来说可以分为几大类：

• 源码修改
  • push
  • pull_request
  • create
  • delete
  • 等和源码或版本管理相关的事件
• 仓库状态
  • issue
  • discussion
  • project
  • 等 GitHub 平台相关的事件
• 其他
  • 手动：workflow_dispatch
  • 计划时间：schedule
  • 被调用：workflow_call
  • 等其他事件

具体定义和用法可以参考官方文档。以上触发事件可以多个自由组合，在配置文件中的定义方式为：

1
on:
2
  push:
3
    branches:
4
      - master
5
  pull_request:
6
    branches:
7
      - master

工作任务

当触发了某个事件时，就会执行相应的工作任务，每个任务直接由其 ID 引导，可以配置不同的权限许可和环境，也可以通过 needs 关键字来定义依赖关系。每个任务都可以分为几个步骤，每个步骤都可以配置不同的环境。当然每个任务和步骤都可以通过简单的条件判断来控制是否执行。

在这里，运行的任务和步骤的两大核心操作为：

• 复用 uses
  • 调用一个现有 action
  • 可以是 GitHub Marketplace 上提供的
  • 也可以是指向自己写的工作流文件路径
  • 参数通过 with 传递
• 自定义 run
  • 直接运行命令
  • 由于是在容器中运行，所以基本上可以运行任何命令

更多语法以及示例可参考官方文档。

GitHub Actions 实践

以下是一个简单的 GitHub Actions 配置文件

1
# 工作流名称
2
name: GitHub Actions Demo
3

4
# 触发条件
5
on:
6
  # 有推送时触发
7
  push:
8
    branches:
9
      - main
10
  # 有 PR 时触发
11
  pull_request:
12
    branches:
13
      - main
14
  # 手动触发
15
  workflow_dispatch:
16
  # 定时触发
17
  schedule:
18
    # 每天 0 点 0 分
19
    - cron: "0 0 * * *"
20

21
# 任务
22
jobs:
23
  # 任务 ID
24
  build:
25
    # 运行环境
26
    runs-on: ubuntu-latest
27

28
    # 任务步骤
29
    steps:
30
      # 检出代码（使用现成 action）
31
      - uses: actions/checkout@v3
32

33
      # 执行命令（命令行）
34
      - name: Run a one-line script
35
        run: echo Hello GitHub Actions
36

37
      # 执行命令（多行）
38
      - name: Run a multi-line script
39
        run: |
40
          echo Add other actions to build,
41
          echo test, and deploy your project.

实际案例

自动构建并部署博客

这是我最初使用 GitHub Actions 的场景，在有 push 时自动构建并部署，见此工作流文件

定时更新爬取 PKU 课程列表

趁着放假，拿之前写的爬虫脚本改巴改巴，规定了定时任务，并且自动将结果发布到 release，见此工作流文件