GitHubAction介绍

一.GitHubAction简介

🧅什么是Github Action ?

• 持续集成/持续交付的概念。

• Git相关知识。

• Linux或Windows或macOS脚本相关知识。

• Yaml基础语法。

🍤什么是Yaml ?

• 大小写敏感。

• 使用缩进表示层级关系。

• 缩进只能使用空格，不能用 TAB 字符。

• 缩进的空格数量不重要，只要层级相同的元素左对齐即可。

• ‘#’ 表示注释。

🍝Github Action基本概念

• workflow: 一个 workflow 就是一个完整的工作流过程，每个workflow 包含一组 jobs任务。

• job : jobs任务包含一个或多个job ，每个 job包含一系列的 steps 步骤。

• step : 每个 step 步骤可以执行指令或者使用一个 action 动作。

• action : 每个 action 动作就是一个通用的基本单元。

🍓Github Action 的使用限制

二.GitHubAction的使用

😀workflow

name: hello-github-actions # 触发 workflow 的事件
on:
  push: # 分支随意
    branches:
      - master
# 一个 workflow 由执行的一项或多项 job
jobs:
  # 一个 job 任务，任务名为 build
  build:
    # 运行在最新版 ubuntu 系统中
    runs-on: ubuntu-latest
    # 步骤合集
    steps:
      # 新建一个名为 checkout_actions 的步骤
      - name: checkout_actions
        # 使用 checkout@v2 这个 action 获取源码
        uses: actions/checkout@v2
      # 使用建一个名为 setup-node 的步骤
      - name: setup-node
        # 使用 setup-node@v1 这个 action
        uses: actions/setup-node@v1
        # 指定某个 action 可能需要输入的参数
        with:
          node-version: '14'
      - name: npm install and build
        # 执行执行某个 shell 命令或脚本
        run: |
          npm install
          npm run build
      - name: commit push
        # 执行执行某个 shell 命令或脚本
        run: |
          git config --global user.email [email protected]
          git config --global user.name xxxx
          git add .
          git commit -m "update" -a
          git push
    # 环境变量
    env:
      email: [email protected]

😂name

🤣on

on: [push, merge]

on:
  push:
    branches:
      - master

😉jobs

1.job

jobs:
  job1:
    …
  job2:
    …

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

2.job->runs-on

• ubuntu-latest，ubuntu-18.04或ubuntu-16.04。

• windows-latest，windows-2019或windows-2016。

• macOS-latest或macOS-10.14。

jobs:
  job1:
    runs-on: ubuntu-18.04
  job2:
    runs-on: macos-10.15
  job3:
    runs-on: windows-2019

• 2核处理器。

• 7GB内存。

• 14GB固态硬盘空间。

• 3核处理器。

• 14GB内存。

• 14GB固态硬盘空间。

3.job->env

• jobs->job->env

• jobs->job->steps.env

4.job->steps

• name：步骤名称，步骤的名称。

• env：该步骤所需的环境变量。

• id : 每个步骤的唯一标识符

• uses : 使用哪个action，这个表示使用别人预先设置好的Actions，比如因为我代码中要用到python，所以就用了actions/setup-python@v1来设置python环境，不用我自己设置了。

• with: 指定某个action 可能需要输入的参数。

• run: 执行哪些指令，具体运行什么命令行代码。

• continue-on-error : 设置为 true 允许此步骤失败job 仍然通过。

• timeout-minutes : step 的超时时间。

name: Sync To Gitee
on:
  push:
jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - name: PrintName
        env:
          name: "zhangsan"
        run: |
          echo $name
      - name: SetUpPython
        uses: actions/setup-python@v1
        with:
          python-version: 3.7
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install requests
          pip install bs4
          pip install lxml

5.Action

• actions/setup-node@74bc508：指向一个 commit。

• actions/[email protected]：指向一个标签。

• actions/setup-node@master：指向一个分支。

• 大小写敏感。

• 使用缩进表示层级关系。

• 缩进只能使用空格，不能用 TAB 字符。

• 缩进的空格数量不重要，只要层级相同的元素左对齐即可。

• # 表示注释。

• 作业执行时间 - 工作流中的每个作业最多可以运行 6 小时的执行时间。如果作业达到此限制，该作业将终止且无法完成。

• 工作流运行时间 - 每个工作流运行限制为 35 天。如果工作流运行达到此限制，则工作流运行将被取消。此时间段包括执行持续时间以及等待和批准所花费的时间。

• API 请求 - 您可以在一小时内跨存储库中的所有操作执行多达 1000 个 API 请求。如果超出此限制，其他 API 调用将失败，这可能会导致作业失败。

• 并发作业 - 可以在帐户中运行的并发作业数取决于 GitHub 计划。如果超出，则任何其他作业都将排队。

• 作业矩阵 - 作业矩阵每次工作流运行最多可以生成 256 个作业。此限制适用于 GitHub 托管和自托管的运行程序。

• 工作流运行队列 - 每个存储库的排队时间间隔不超过 500 个工作流运行，间隔为 10 秒。如果工作流运行达到此限制，则工作流运行将终止且无法完成。

😊GitHub Actions 中使用密文

- name: setup aliyun oss
  uses: manyuanrong/setup-ossutil@master
  with:
    endpoint: oss-cn-beijing.aliyuncs.com
    access-key-id: ${{ secrets.OSS_KEY_ID }}
    access-key-secret: ${{ secrets.OSS_KEY_SECRET }}

😎GitHubAction执行结果

三.示例

name: github-action-email
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    # 检出代码
    - name: CheckoutRepo
      uses: actions/checkout@v2
    # 获取master分支上最新一条提交的git log
    - name: GetLastLog
      id: git_log
      uses: Edisonboy/latest-git-log-action@main
      with:
        tag: origin/master
    # 发送邮件
    - name: Send email
      uses: dawidd6/action-send-mail@v3
      with:
        server_address: smtp.qq.com
        server_port: 465
        username: ${{secrets.MAIL_USERNAME}}
        password: ${{secrets.MAIL_PASSWORD}}
        subject: Github Actions job result
        to: ${{secrets.MAIL_TOUSERNAME}}
        from: ${{secrets.MAIL_USERNAME}}
        body: ${{github.repository}} push log : ${{steps.git_log.outputs.log}}

• secrets.XXX：GitHub 允许仓库所有者创建和管理需要保密性的参数。例如邮件的账号和密码都是属于敏感参数。可以通过项目Settings -> Secrets -> Actions配置密码，在这里我们添加 MAIL_USERNAME、MAIL_PASSWORD、MAIL_TOUSERNAME 三个配置参数（注意：这里的密码是指 SMTP 服务的授权密码）。

• 上下文：可以访问工作流程运行、运行器环境、作业及步骤相关信息的方式
• github.repository：当前仓库的的所有者和仓库名称。
• steps.git_log.outputs.log：获取step id 为 git_log 的输出