GitHub Actions 指南(下)

简介: GitHub Actions 指南

steps

steps 的通用格式类似于:

steps:
  - name: <step_name>
    uses: <action>
    with:
      <parameter_name>: <parameter_value>
    id: <step_id>
    continue-on-error: true
  - name: <step_name>
    timeout-minutes:
    run: <commands>

每个 step 步骤可以有:

  • id : 每个步骤的唯一标识符
  • name : 步骤的名称
  • uses : 使用哪个 action
  • run : 执行哪些指令
  • with : 指定某个 action 可能需要输入的参数
  • continue-on-error : 设置为 true 允许此步骤失败 job 仍然通过
  • timeout-minutes : step 的超时时间

action

action 动作通常是可以通用的,这意味着你可以直接使用别人定义好的 action 。

checkout action

checkout action 是一个标准动作,当以下情况时必须且需要率先使用:

  • workflow 需要项目库的代码副本,比如构建、测试、或持续集成这些操作。
  • workflow 中至少有一个 action 是在同一个项目库下定义的。

使用示例:

- uses: actions/checkout@v1

如果你只想浅克隆你的库,或者只复制最新的版本,你可以在 with 中使用 fetch-depth 声明,例如:

- uses: actions/checkout@v1
  with:
    fetch-depth: 1

引用 action

  • 官方 action 标准库: github.com/actions
  • 社区库: marketplace

1、引用公有库中的 action

引用 action 的格式是 {owner}/{repo}@{ref}{owner}/{repo}/{path}@{ref} ,例如上例的中 actions/checkout@v1 ,你还可以使用标准库中的其它 action ,如设置 node 版本:

jobs:
  my_first_job:
    name: My Job Name
      steps:
        - uses: actions/setup-node@v1
          with:
            node-version: 10.x

2、引用同一个库中的 action

引用格式:{owner}/{repo}@{ref}./path/to/dir

例如项目文件结构为:

|-- hello-world (repository)
|   |__ .github
|       └── workflows
|           └── my-first-workflow.yml
|       └── actions
|           |__ hello-world-action
|               └── action.yml

当你想要在 workflow 中引用自己的 action 时可以:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      # This step checks out a copy of your repository.
      - uses: actions/checkout@v1
      # This step references the directory that contains the action.
      - uses: ./.github/actions/hello-world-action

3、引用 Docker Hub 上的 container

如果某个 action 定义在了一个 docker container image 中且推送到了 Docker Hub 上,你也可以引入它,格式是 docker://{image}:{tag} ,示例:

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

更多信息参考: Docker-image.yml workflow 和 Creating a Docker container action 。

构建 actions

请参考:building-actions


env

环境变量可以配置在以下地方:

  • env
  • jobs.<job_id>.env
  • jobs.<job_id>.steps.env

示例:

env:
  NODE_ENV: dev
jobs:
  job1:
    env:
      NODE_ENV: test
    steps:
      - name:
        env:
          NODE_ENV: prod

如果重复,优先使用最近的那个。


if & context

你可以在 job 和 step 中使用 if 条件语句,只有满足条件时才执行具体的 job 或 step :

  • jobs.<job_id>.if
  • jobs.<job_id>.steps.if

任务状态检查函数:

  • success() : 当上一步执行成功时返回 true
  • always() : 总是返回 true
  • cancelled() : 当 workflow 被取消时返回 true
  • failure() : 当上一步执行失败时返回 true

例如:

steps:
  - name: step1
    if: always()
  - name: step2
    if: success()
  - name: step3
    if: failure()

意思就是 step1 总是执行,step2 需要上一步执行成功才执行,step3 只有当上一步执行失败才执行。

${{<expression>}}

上下文和表达式: ${{<expression>}}

有时候我们需要与第三方平台进行交互,这时候通常需要配置一个 token ,但是显然这个 token 不可能明文使用,这种个情况下我们要做的就是:

  1. 在具体 repository 库 SettingsSecrets 中添加一个密钥,如 SOMEONE_TOKEN
  2. 然后在 workflow 中就可以通过 ${{secrets.SOMEONE_TOKEN}} 将 token 安全地传递给环境变量。
steps:
  - name: My first action
    env:
      SOMEONE_TOKEN: ${{ secrets.SOMEONE_TOKEN }}

这里的 secrets 就是一个上下文,除此之外还有很多,比如:

  • github.event_name : 触发 workflow 的事件名称
  • job.status : 当前 job 的状态,如 success, failure, or cancelled
  • steps.<step id>.outputs : 某个 action 的输出
  • runner.os : runner 的操作系统如 Linux, Windows, or macOS

这里只列举了少数几个。

另外在 if 中使用时不需要 ${{}} 符号,比如:

steps:
 - name: My first step
   if: github.event_name == 'pull_request' && github.event.action == 'unassigned'
   run: echo This event is a pull request that had an assignee removed.

上下文和表达式详细信息请参考:contexts-and-expression


结语

最后给个自己写的示例,仅供参考:

name: GitHub Actions CI
on: [push]
jobs:
  build-test-deploy:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [8.x, 10.x, 12.x]
    steps:
    - uses: actions/checkout@v1
    - name: install linux packages
      run:  sudo apt-get install -y--no-install-recommends libevent-dev
    - name: install memcached
      if: success()
      run: |
        wget -O memcached.tar.gz http://memcached.org/files/memcached-1.5.20.tar.gz
        tar -zxvf memcached.tar.gz
        cd memcached-1.5.20
        ./configure && make && sudo make install
        memcached -d
    - name: Use Node.js ${{ matrix.node-version }}
      uses: actions/setup-node@v1
      if: success()
      with:
        node-version: ${{ matrix.node-version }}
    - name: npm install, build, and test
      env:
        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
      if: success()
      run: |
        npm ci
        npm test
        npm run report-coverage


目录
相关文章
|
7月前
|
监控 安全 机器人
通过GitHub Actions给微信公众测试号和钉钉群定时推送消息(Python)
通过GitHub Actions给微信公众测试号和钉钉群定时推送消息(Python)
116 0
|
9月前
|
存储 Ubuntu 持续交付
GitHub Actions 指南(上)
GitHub Actions 指南
116 0
|
1月前
|
存储 安全 Serverless
用 Github Actions 自动部署阿里云函数计算 FC
介绍了如何配置阿里云函数计算(FC)与GitHub Actions集成以实现自动部署。首先在阿里云创建函数,然后在项目根目录创建`s.yaml`文件配置Serverless Devs。接着在GitHub仓库中设置 Secrets 存储阿里云账号信息,并创建名为`aliyun-fc-deploy.yaml`的工作流文件来定义GitHub Actions。当代码推送到`master`分支时,Actions会自动部署到函数计算。最后,成功配置后,提交代码会触发自动部署,并可在GitHub Actions和阿里云控制台查看部署状态。
470 3
|
1月前
|
JavaScript Ubuntu 网络安全
使用github actions,将私有仓库的构建文件发布到另一个公开仓库,并同步到gitee
使用github actions,将私有仓库的构建文件发布到另一个公开仓库,并同步到gitee
159 0
|
10月前
|
前端开发 Ubuntu jenkins
前端项目自动化部署——超详细教程(Jenkins、Github Actions)(三)
前端项目自动化部署——超详细教程(Jenkins、Github Actions)(三)
501 0
|
10月前
|
前端开发 jenkins Linux
前端项目自动化部署——超详细教程(Jenkins、Github Actions)(二)
前端项目自动化部署——超详细教程(Jenkins、Github Actions)(二)
887 0
|
10月前
|
前端开发 JavaScript jenkins
前端项目自动化部署——超详细教程(Jenkins、Github Actions)(一)
前端项目自动化部署——超详细教程(Jenkins、Github Actions)
380 0
|
Java 持续交付 开发工具
我明白了,github中的actions与pages
github的actions是一个持续集成的工具,类似java的jekins,actions中需要编写流水线脚本,脚本并不难,只是环境的熟悉。github pages 是一个静态网站服务,只要你按照特定规则在指定的仓库或者分支上存放html代码,就可以通过特定规则的url去访问到该静态页面网站,很方便。
242 0
我明白了,github中的actions与pages
|
JavaScript 开发工具 git
GitHub Actions:从使用action操作到自定义action操作
GitHub Actions:从使用action操作到自定义action操作
192 0
|
Python
Python实战:GitHub Actions自动构建pypa/gh-action-pypi-publish自动发布新版本到pypi
Python实战:GitHub Actions自动构建pypa/gh-action-pypi-publish自动发布新版本到pypi
176 0