Github Actions 备忘清单

GitHub Actions 的仓库中自动化、自定义和执行软件开发工作流程，有四个基本的概念，如下：

• 采用 YAML 格式定义配置文件
• 存放在代码仓库的 .github/workflows 目录中
• 后缀名统一为 .yml，比如 ci.yml
• 一个库可以有多个 workflow 文件
• 根据配置事件自动运行配置文件

name: GitHub Actions Demo
on:
  push:
    branches:
      - main

# 任务
jobs:
  build:
    runs-on: ubuntu-latest
    # 步骤 根据步骤执行任务
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 16

      - run: npm install
      - run: npm run build

存放到 .github/workflows 目录中，命名为 ci.yml，当 push 代码到仓库 main 分支中，该配置自动运行配置。

jobs:
  my_first_job:  # 第一个任务
    name: My first job

  my_second_job: # 第二个任务
    name: My second job

通过 jobs (jobs.<job_id>.name)字段，配置一项或多项需要执行的任务

通过 needs (jobs.<job_id>.needs)字段，指定当前任务的依赖关系

jobs:
  job1:
  job2:
    needs: job1
  job3:
    needs: [job1, job2]

上面配置中，job1 必须先于 job2 完成，而 job3 等待 job1 和 job2 的完成才能运行。因此，这个 workflow 的运行顺序依次为：job1、job2、job3

可以使用 cron 表达式配置周期性任务，定时执行

name: schedule task

# 要注意时差，最好手动指定时区
env:
  TZ: Asia/Shanghai

on:
  # push 到 main 分支时执行任务
  push:
    branches:
      - main
  # 每隔两小时自动执行任务
  schedule:
   - cron: '0 0/2 * * *'

runs-on: ubuntu-latest

指定运行所需要的虚拟机环境，⚠️ 它是必填字段

jobs:
  build: # 任务名称
    runs-on: ubuntu-latest # 虚拟机环境配置

• Windows Server 2022 (windows-latest) 或 (windows-2022)
• Ubuntu 20.04 (ubuntu-latest) 或 (ubuntu-20.04)
• macOS Monterey 12 (macos-12)
• macOS Big Sur 11 (macos-latest),(macos-11)

另见: 选择 GitHub 托管的运行器

每个步骤都可以指定以下三个字段

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

steps 字段指定每个 Job 的运行步骤，可以包含一个或多个步骤(steps)

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 16

      - run: npm install
      - run: npm run build

作为表达式的一部分，可以使用 boolean, null, number 或 string数据类型

env:
  myNull: ${{ null }}
  myBoolean: ${{ false }}
  myIntegerNumber: ${{ 711 }}
  myFloatNumber: ${{ -9.2 }}
  myHexNumber: ${{ 0xff }}
  myExponentialNumber: ${{ -2.99e-2 }}
  myString: Mona the Octocat
  myStringInBraces: ${{ 'It''s source!' }}

使用字符串的示例

contains('Hello world', 'llo') // 返回 true

使用对象过滤器的示例返回 true

contains(github.event.issue.labels.*.name, 'bug')

另见: 函数 contains

startsWith('Hello world', 'He') // 返回 true

另见: 函数 startsWith，此函数不区分大小写

format('{{Hello {0} {1} {2}!}}', 'Mona', 'the', 'Octocat')
// 返回 '{Hello Mona the Octocat!}'.

另见: 函数 format

join(github.event.issue.labels.*.name,', ')
// 也许返回 'bug, help wanted'.

另见: 函数 join

toJSON(job)
// 也许返回 { "status": "Success" }.

另见: 函数 toJSON

steps:
  ...
  - name: 作业已成功
    if: ${{ success() }}

steps:
  ...
  - name: 作业失败
    if: ${{ failure() }}

- name: Deploy
  uses: peaceiris/actions-gh-pages@v3
  with:
    github_token: ${{secrets.GITHUB_TOKEN}}
    publish_dir: ./build

- name: Modify Version
  shell: bash
  run: |
    node -e 'var pkg = require("./package.json"); pkg.version= (new Date().getFullYear().toString().substr(2)) + "." + (new Date().getMonth() + 1) + "." + (new Date().getDate()); require("fs").writeFileSync("./package.json", JSON.stringify(pkg, null, 2))'

使用 github-action-package 修改 name 字段

- name: package.json info
  uses: jaywcjlove/github-action-package@main
  with:
    rename: '@wcj/github-package-test'

- name: Checkout
  uses: actions/checkout@v3
  with:
    path: main
    submodules: true

submodules：true 检出子模块或 recursive 递归检出子模块

- name: Clone sub repository
  shell: bash
  run: |
    auth_header="$(git config --local --get http.https://github.com/.extraheader)"
    # git submodule sync --recursive
    # git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --remote --force --recursive --checkout ant.design

- run: npm publish --access public
  continue-on-error: true
  env:
    NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

获取 NPM_TOKEN，可以通过 npm 账号创建 token

npm token list [--json|--parseable] # 查看
npm token create [--read-only] [--cidr=1.1.1.1/24,2.2.2.2/16] # 创建
npm token revoke <id|token> # 撤销

可以使用 JS-DevTools/npm-publish 提交

- name:  📦 @province-city-china/data
  uses: JS-DevTools/npm-publish@v1
  with:
    token: ${{ secrets.NPM_TOKEN }}
    package: packages/data/package.json

它有个好处，检测 package.json 中版本号是否发生变更，来决定是否提交版本，不会引发流程错误。

Artifacts 是 GitHub Actions 为您提供持久文件并在运行完成后使用它们或在作业（文档）之间共享的一种方式。

• 要创建工件并使用它，您将需要不同的操作：上传和下载

要上传文件或目录，您只需像这样使用它：

steps:
  - uses: actions/checkout@v2
  - run: mkdir -p path/to/artifact
  - run: echo hello > path/to/file/a.txt
  - uses: actions/upload-artifact@v2
    with:
      name: my-artifact
      path: path/to/artifact/a.txt

然后下载 artifact 以使用它：

steps:
  - uses: actions/checkout@v2
  - uses: actions/download-artifact@v2
    with:
      name: my-artifact

- name: Setup Node
  uses: actions/setup-node@v2
  with:
    node-version: 14

使用矩阵策略 在 nodejs 不同版本中运行

strategy:
  matrix:
    node-version: [10.x, 12.x, 14.x]

steps:
  - uses: actions/checkout@v2
  - name: 使用 Node ${{ matrix.node-version }}
    uses: actions/setup-node@v1
    with:
      node-version: ${{ matrix.node-version }}
  - run: npm ci
  - run: npm run build --if-present
  - run: npm test

- name: Create Tag
  id: create_tag
  uses: jaywcjlove/create-tag-action@main
  with:
    package-path: ./package.json

根据 package-path 指定的 package.json 检测 version 是否发生变化来创建 tag

- name: Generate Changelog
  id: changelog
  uses: jaywcjlove/changelog-generator@main
  with:
    filter-author: (小弟调调™)

- name: Get the changelog
  run: echo "${{ steps.changelog.outputs.changelog }}"

创建一个文件，然后将其作为构件上传

jobs:
  example-job:
    name: Save output
    steps:
      - shell: bash
        run: |
          expr 1 + 1 > output.log
      - name: Upload output file
        uses: actions/upload-artifact@v3
        with:
          name: output-log-file
          path: output.log

可以下载名为 output-log-file 的工件

jobs:
  example-job:
    steps:
      - name: Download a single artifact
        uses: actions/download-artifact@v3
        with:
          name: output-log-file

使用 bash 运行脚本

steps:
  - name: Display the path
    run: echo $PATH
    shell: bash

运行 python 脚本

steps:
  - name: Display the path
    run: |
      import os
      print(os.environ['PATH'])
    shell: python

您可以使用 shell 关键字覆盖运行器操作系统中的默认 shell 设置

- name: Generate Contributors Images
  uses: jaywcjlove/github-action-contributors@main
  id: contributors
  with:
    output: dist/CONTRIBUTORS.svg
    avatarSize: 42

- uses: actions/checkout@v3
- uses: actions/setup-node@v3
  with:
    node-version: 16

- run: npm publish
  continue-on-error: true
  env:
    NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

当 npm 推送包失败不影响整个流程，可用于自动发包

- name: Setup Yarn
  uses: threeal/setup-yarn-[email protected]
  with:
    cache: false
    version: 1.22.21

在 tag.yml 上添加判断 tag 创建成功触发 tag-creation-success 的工作流

- name: Trigger next workflow if successful
  if: steps.check_success.outputs.success == 'true'
  run: |
    curl -X POST \
      -H "Accept: application/vnd.github.v3+json" \
      -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
      -d '{"event_type": "tag-creation-success"}' \
      https://api.github.com/repos/${{ github.repository }}/dispatches

在 success.yml 上监听

on:
  repository_dispatch:
    types: [tag-creation-success]

GitLab CI/CD

job1:
  variables:
    GIT_CHECKOUT: "true"
  script:
    - echo "Run your script here"

GitHub Actions

jobs:
  job1:
    steps:
      - uses: actions/checkout@v3
      - run: echo "Run your script here"

GitLab CI/CD

my_job:
  image: node:10.16-jessie

GitHub Actions

jobs:
  my_job:
    container: node:10.16-jessie

GitLab CI/CD

deploy_prod:
  stage: deploy
  script:
    - echo "部署到生产服务器"
  rules:
    - if: '$CI_COMMIT_BRANCH == "master"'

GitHub Actions

jobs:
  deploy_prod:
    if: contains( github.ref, 'master')
    runs-on: ubuntu-latest
    steps:
      - run: echo "部署到生产服务器"

GitLab CI/CD

script:
artifacts:
  paths:
    - math-homework.txt

GitHub Actions

- name: Upload math result for job 1
  uses: actions/upload-artifact@v3
  with:
    name: homework
    path: math-homework.txt

GitLab CI/CD

stages:
  - build
  - test
  - deploy

build_a: stage: build script:
    - echo "该作业将首先运行"

build_b: stage: build script:
    - echo "该作业将首先运行，与 build_a 并行"

test_ab: stage: test script:
    - echo "此作业将在 build_a 和 build_b 完成后运行"

deploy_ab: stage: deploy script:
    - echo "此作业将在 test_ab 完成后运行"

GitHub Actions

jobs:
  build_a:
    runs-on: ubuntu-latest
    steps:
      - run: echo "该作业将首先运行"

  build_b:
    runs-on: ubuntu-latest
    steps:
      - run: echo "该作业将首先运行，与 build_a 并行"

  test_ab:
    runs-on: ubuntu-latest
    needs: [build_a,build_b]
    steps:
      - run: echo "此作业将在 build_a 和 build_b 完成后运行"

  deploy_ab:
    runs-on: ubuntu-latest
    needs: [test_ab]
    steps:
      - run: echo "此作业将在 test_ab 完成后运行"

GitLab CI/CD

image: node:latest

cache: key: $CI_COMMIT_REF_SLUG paths:
    - .npm/

before_script:
  - npm ci --cache .npm --prefer-offline

test_async: script:
    - node ./specs/start.js ./specs/async.spec.js

GitHub Actions

jobs:
  test_async:
    runs-on: ubuntu-latest
    steps:
    - name: Cache node modules
      uses: actions/cache@v3
      with:
        path: ~/.npm
        key: v1-npm-deps-${{ hashFiles('**/package-lock.json') }}
        restore-keys: v1-npm-deps-

GitLab CI/CD

container-job:
  variables:
    POSTGRES_PASSWORD: postgres
    # PostgreSQL 服务容器通信的主机名
    POSTGRES_HOST: postgres
    # 默认的 PostgreSQL 端口
    POSTGRES_PORT: 5432
  image: node:10.18-jessie
  services:
    - postgres
  script:
    # 执行 package.json 文件中
    # 所有依赖项的全新安装
    - npm ci
    # 运行创建 PostgreSQL 客户端的脚本，
    # 用数据填充客户端，并检索数据
    - node client.js
  tags:
    - docker

GitHub Actions

jobs:
  container-job:
    runs-on: ubuntu-latest
    container: node:10.18-jessie

    services:
      postgres:
        image: postgres
        env:
          POSTGRES_PASSWORD: postgres

    steps:
      - name: Check out repository code
        uses: actions/checkout@v3

      # 执行 package.json 文件中
      # 所有依赖项的全新安装
      - name: Install dependencies
        run: npm ci

      - name: Connect to PostgreSQL
        # 运行创建 PostgreSQL 客户端的脚本，
        # 用数据填充客户端，并检索数据
        run: node client.js
        env:
          # PostgreSQL 服务容器通信的主机名
          POSTGRES_HOST: postgres
          # 默认的 PostgreSQL 端口
          POSTGRES_PORT: 5432