GitHub Action

WorkFlow

GithubWorkFlow 就是 git 自带的 CI 服务

WorkFlow 文件

name: Greet Everyone
# 事件
on: [push]
# 工作集合
jobs:
  build:
    # 作业名称为 Greeting
    name: Greeting
    # 此作业在 Linux 上运行,runs-on选项一共就有几种类型
    runs-on: ubuntu-latest
    steps:
      # 此步骤使用 GitHub 的 hello-world-javascript-action：https://github.com/actions/hello-world-javascript-action
      - name: Hello world
        uses: actions/hello-world-javascript-action@v1
        with:
          who-to-greet: 'Mona the Octocat'
        id: hello
      # 此步骤打印上一步操作的输出（时间）。
      - name: Echo the greeting's time
        run: echo 'The time was ${{ steps.hello.outputs.time }}.'
​

工作流程语法

工作流程语法原文

• name
  工作流程的名称
• on
  触发时机,push,pull_request,create 更多
  具有活动类型或配置的多个事件示例

on:
  push:
    branches:
     # master分支发push请求时
      - master
  pull_request:
    branches:
     # master分支pull_request时
      - master
  page_build:
  release:
    types: 
      - created
​

• on.<event_name>.types

# 当release的published,created,edited事件被触发时
on:
  release:
    types: [published,created,edited]
​

• on.<push|pull_request>.<brancheds|tags>

# 在这些分支和tag被push代码时触发
# ignore在这些分支和tag被push时不会触发
on:
  push:
    branches:
      - master
      - 'mona/octocat'
      - 'releases/**'
    tags:
      - v1
      - v1.*
    branches-ignore:
      - devp
      - '**-alpha'
    tags-ignore:
      - v2.*
​

• on.<push|pull_request>.paths

# 当有js被推送时触发
# 当docs下推送时不触发
on:
  push:
    paths:
    - '**.js'
    paths-ignore:
    - 'docs/**'
​

• on.schedule
  POSIX cron

# 每隔15分钟构建一次
on:
   schedule:
       - cron: '*/15 * * * *'
​

• env

env:
   SERVER: production
​

• jobs
  工作流程运行包括一项或多项作业。 作业默认是并行运行。 要按顺序运行作业，您可以使用
• jobs.<job_id>(.name)

jobs:
    my_first_job:
        name: MyfirstJob
    my_second_job:
        name: MysecondJob
​

• jobs.<job_id>.needs
  job 的依赖关系

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

• jobs.<job_id>.runs-on

runs-on : windows-latest
​

• jobs.<job_id>.env

jobs:
  job1:
    env:
      FIRST_NAME: mona
​

• jobs.<job_id>.if
• jobs.<job_id>.steps
  为作业定义的变量在作业执行时将覆盖名称相同的工作流程变量。步骤可以运行命令、运行设置任务，或者运行您的仓库、公共仓库中的操作或 Docker 注册表中发布的操作。 并非所有步骤都会运行操作，但所有操作都会作为步骤运行。

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.
​

• jobs.<job_id>.stemp2.uses
  可以使用工作流程所在仓库中、公共仓库中或发布 Docker 容器镜像中定义的操作

jobs:
  my_first_job:
    steps:
      - name: My first step
        uses: actions/heroku@master
      - name: My second step
        uses: actions/aws@v2.0.1


jobs:
  my_first_job:
    steps:
      - name: My first step
        uses: docker://alpine:3.8
​

• jobs.<job_id>.steps.run
  使用 shell,working-directory:指定命令的工作目录,shell 指定 cmd 环境

- name: install dependencies and build
  run: |
     npm ci
  shell: bash




- name: Clean temp directory
  run: rm -rf *
  working-directory: ./temp
​

环境列表 `

• jobs.<job_id>.steps.with
  传入参数

# with传入了actions/hello_word@master操作所需要的三个参数,参数名称为fitst_name,middle_name,last_name
jobs:
  my_first_job:
    steps:
      - name: My first step
        uses: actions/hello_world@master
        with:
          first_name: Mona
          middle_name: The
          last_name: Octocat    
​

• jobs.<job_id>.steps.with.args
  docker 容器参数

steps:
  - name: Explain why this job ran
    uses: monacorp/action-name@master
    with:
      entrypoint: /bin/echo
      args: The ${{ github.event_name }} event triggered this step.

​

• jobs.<job_id>.steps.with.entrypoint
  覆盖 dockerfile 中的 docker entrypoint

steps:
  - name: Run a custom command
    uses: monacorp/action-name@master
    with:
      entrypoint: /a/different/executable
​

• jobs.<job_id>.steps.env
  设置整个工作流程或某个作业的环境变量。
  公共操作可在自述文件中指定预期的环境变量。 如果要在环境变量中设置密码，必须使用 secrets 上下文设置

steps:
  - name: My first action
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      FIRST_NAME: Mona
      LAST_NAME: Octocat
​

• jobs.<job_id>.steps.continue-on-error
  错误跳过

steps:
  - continue-on-error: true
  - name: My first action
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      FIRST_NAME: Mona
      LAST_NAME: Octocat

​

• jobs.<job_id>.steps.timeout-minutes
  最大运行时间
• jobs.<job_id>.strategy
  矩阵，比如 3*3 实际是 9 个任务

# 3*1 3个任务，每个都会试
strategy:
  matrix:
    node: [6, 8, 10]
steps:
  # Configures the node version used on GitHub-hosted runners
  - uses: actions/setup-node@v1
    with:
      # The Node.js version to configure
      node-version: ${{ matrix.node }}

​

# os和node全排列
runs-on: ${{ matrix.os }}
strategy:
  matrix:
    os: [ubuntu-16.04, ubuntu-18.04]
    node: [6, 8, 10]
steps:
  - uses: actions/setup-node@v1
    with:
      node-version: ${{ matrix.node }}

​

添加额外的配置到矩阵中

# include 在os为windows-latest时且node为4时，npm为2
runs-on: ${{ matrix.os }}
strategy:
  matrix:
    os: [macos-latest, windows-latest, ubuntu-18.04]
    node: [4, 6, 8, 10]
    include:
      - os: windows-latest
        node: 4
        npm: 2
​

• jobs.<job_id>.strategy.fail-fast
  任何 matrix 作业失败,取消所有进行中的作业,默认为 true
• jobs.<job_id>.strategy.max-parallel
  使用 matrix 作业策略时同时运行的最大作业数,默认情况下,github 将最大并发运行的作业数量

strategy:
  max-parallel: 2
​

• jobs.<job_id>.container
  用于运行作业中尚未指定容器的任何步骤的容器。

jobs:
  my_job:
    container:
      image: node:10.16-jessie
      env:
        NODE_ENV: development
      ports:
        - 80
      volumes:
        - my_docker_volume:/volume_mount
      options: --cpus 1

​

• jobs.<job_id>.container.options
  附加 docker 容器资源选项
• jobs.<job_id>.services
  为 ci 提供服务

services:
  nginx:
    image: nginx
    volumes:
      - my_docker_volume:/volume_mount
      - /data/my_data
      - /source/directory:/destination/directory
    ports:
      - 8080:80
  redis:
    image: redis
    ports:
      - 6379/tcp

​

非卖品

项目地址：https://github.com/ferried/animal-crossing-cli

action 地址 ： https://github.com/ferried/animal-crossing-cli/runs/648812568?check_suite_focus=true

name: Go
on:
  push:
    branches: [ devp ]
  pull_request:
    branches: [ devp ]
jobs:
  release:
    name: release
    runs-on: ubuntu-latest
    steps:

      - name: setup go
        uses: actions/setup-go@v2
        with:
          go-version: ^1.13
          id: go

      - name: checkout code
        uses: actions/checkout@v2

      - name: install dependencies
        run: |
          go get -v -t -d ./...
          if [ -f Gopkg.toml ]; then
              curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
              dep ensure
          fi

      - name: test code
        run: go test

​