Github Actions详解 | EnlightenCode

基本概念

workflow （工作流程）：持续集成一次运行的过程，就是一个 workflow。
job （任务）：一个 workflow 由一个或多个 jobs 构成，含义是一次持续集成的运行，可以完成多个任务。
step（步骤）：每个 job 由多个 step 构成，一步步完成。
action （动作）：每个 step 可以依次执行一个或多个命令（action）。

workflow 文件

GitHub Actions 的配置文件叫做 workflow 文件，存放在代码仓库的 .github/workflows 目录。

workflow 文件采用 YAML 格式，文件名可以任意取，但是后缀名统一为 .yml ，比如foo.yml。一个库可以有多个 workflow 文件。GitHub 只要发现 .github/workflows 目录里面有 .yml 文件，就会自动运行该文件。

name

name 字段是 workflow 的名称。如果省略该字段，默认为当前 workflow 的文件名。

yaml

name: GitHub Actions Demo

on 字段指定触发 workflow 的条件，通常是某些事件。

yaml

# push事件触发 workflow。
on: push
# on字段也可以是事件的数组。 push事件或pull_request事件都可以触发 workflow。
on: [push, pull_request]

on.<push|pull_request>.<tags|branches>

指定触发事件时，可以限定分支或标签。

yaml

# 只有master分支发生push事件时，才会触发 workflow。
on:
  push:
    branches:    
      - master

jobs.<job_id>.name

workflow 文件的主体是jobs字段，表示要执行的一项或多项任务。

jobs字段里面，需要写出每一项任务的job_id，具体名称自定义。job_id里面的name字段是任务的说明。

yaml

# 下面代码的jobs字段包含两项任务，job_id分别是my_first_job和my_second_job。
jobs:
  my_first_job:
    name: My first job
  my_second_job:
    name: My second job

jobs.<job_id>.needs

needs 字段指定当前任务的依赖关系，即运行顺序。

yaml

# 下面代码中，job1必须先于job2完成，而job3等待job1和job2的完成才能运行。因此，这个 workflow 的运行顺序依次为：job1、job2、job3。
jobs:
  job1:
  job2:
    needs: job1
  job3:
    needs: [job1, job2]

jobs.<job_id>.runs-on

runs-on字段指定运行所需要的虚拟机环境。它是必填字段。

yaml

# 指定虚拟机环境为ubuntu-18.04。
runs-on: ubuntu-18.04

jobs.<job_id>.steps

steps字段指定每个 Job 的运行步骤，可以包含一个或多个步骤。每个步骤都可以指定以下三个字段。

jobs.<job_id>.steps.name：步骤名称。
jobs.<job_id>.steps.run：该步骤运行的命令或者 action。
jobs.<job_id>.steps.env：该步骤所需的环境变量。

yaml

# 下面代码中，steps字段只包括一个步骤。该步骤先注入四个环境变量，然后执行一条 Bash 命令。
name: Greeting from Mona
on: push

jobs:
  my-job:
    name: My Job
    runs-on: ubuntu-latest
    steps:
    - name: Print a greeting
      env:
        MY_VAR: Hi there! My name is
        FIRST_NAME: Mona
        MIDDLE_NAME: The
        LAST_NAME: Octocat
      run: |
        echo $MY_VAR $FIRST_NAME $MIDDLE_NAME $LAST_NAME.

基本概念 ​

workflow 文件 ​

基本概念

workflow 文件