GitHub Actions 速查备忘单

GitHub Actions 是一套 CI/CD 平台，可在 GitHub 仓库中直接自动化构建、测试与部署等工作流。

GitHub Actions 工作流使用特殊 YAML 文件定义，通常存放在仓库的 .github/workflows 目录下。

name: hello-world
on: push
jobs:
  hello-world-job:
    runs-on: ubuntu-latest
    steps:
      - name: Hello World
        run: echo "Hello World!"

Viewing your workflow runs

• On GitHub.com, navigate to the main page of the repository.
• Under your repository name, click Actions.
• In the left sidebar, click the workflow you want to display, in this example "hello-world"

name: learn-github-actions
run-name: ${{ github.actor }} is learning GitHub Actions
on: [push]
jobs:
  check-bats-version:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v3
        with:
          node-version: '14'
      - run: npm install -g bats
      - run: bats -v

name: Event-trigger-on-push-example

on: [push] # 在此处定义事件

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Run a script
        run: echo "This workflow runs on every push to the repository."

事件触发器

单个作业：

name: Single Job
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Run a build script
        run: script/build

多个作业：

name: CI Workflow

on: [push]

jobs:
  job-1:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Runs job 1
        run: echo "Running Job 1"

  job-2:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Runs job 2
        run: echo "Running Job 2"

  job-3:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Runs job 3
        run: echo "Running Job 3"

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
# 步骤 1
      - name: Check out repository
        uses: actions/checkout@v2

# 步骤 2
      - name: Set up Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14'

# 步骤 3
      - name: Install dependencies
        run: npm install

# 步骤 4
      - name: Run tests
        run: npm test

Github 托管运行器：

name: Workflow
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest # 默认运行器
    steps:
      - uses: actions/checkout@v2
      - name: Run a script
        run: echo "Hello, world!"

自托管运行器

name: Workflow with Self-Hosted Runner
on: [push]
jobs:
  build:
    runs-on: self-hosted
    steps:
      - uses: actions/checkout@v2
      - name: Run a script
        run: echo "Hello from self-hosted runner!"

使用环境定义的自定义变量。

jobs:
  build:
    runs-on: ubuntu-latest
    env:
      CUSTOM_VARIABLE: 'Hello, World!' # 使用 env: 定义的自定义变量
    steps:
      - name: Check environment variable
        run: echo "Value of CUSTOM_VAR is $CUSTOM_VAR"

要在 github 仓库中添加新密钥，请导航到 Repository > Settings > Security > Secrets and Variables > Actions > New Repository Secret

密钥工作流示例：

name: Workflow with Secrets

on: [push]

jobs:
  example_job:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2
      - name: Use a secret
        run: echo "The secret is ${{ secrets.MY_SECRET }}"

要访问你的构件，请导航到 Repository > Actions > Workflow Run > Artifacts

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Build project
        run: make build
      - name: Upload build artifact
        uses: actions/upload-artifact@v3 # 上传构件预构建操作
        with:
          name: my-artifact
          path: path/to/artifact

依赖项缓存存储工作流的下载包或编译二进制文件。

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Cache dependencies
        uses: actions/cache@v2 # 存储下载的包或编译的二进制文件
        with:
          path: |
            path/to/dependencies
            another/path
          key: ${{ runner.os }}-deps-${{ hashFiles('**/lockfile') }} # 在操作系统中生成依赖项锁定文件的哈希
      - name: Install dependencies
        run: install-command

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [12.x, 14.x, 16.x]
# 矩阵策略运行使你能够跨多个环境和操作系统组合运行作业
        os: [ubuntu-latest, windows-latest, macOS-latest]
    steps:
      - uses: actions/checkout@v2
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v1
        with:
          node-version: ${{ matrix.node-version }}
      - run: npm install
      - run: npm test
        env:
          CI: true

分支条件：

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      - name: Run build
        if: github.ref == 'refs/heads/main' # "Run build" 步骤仅在当前分支为 main 时执行。
        run: make build

事件触发条件：

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      - name: Run tests
        if: github.event_name == 'pull_request' # "Run tests" 步骤仅在工作流由拉取请求事件触发时执行
        run: npm test

根据你的操作系统，如果你运行的是 ubuntu-latest，bash 命令应该可以工作

steps:
  - name: Set environment variable
    run: echo "NAME=value" >> $GITHUB_ENV

并发字段根据 github.head_ref 创建一个组。如果在同一并发组内启动新运行，它会取消任何正在进行的运行。

jobs:
  my_job:
    runs-on: ubuntu-latest
    concurrency:
      group: ${{ github.head_ref }}
      cancel-in-progress: true
    steps:
      - name: Run a script
        run: echo "Running script..."