• Github Action 市场: https://github.com/marketplace?type=actions
• workflow 字段文档: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions

结构

• workflow
• job
• step
• action

.github/workflows/demo.yml

- workflow
  |- job1
  |   |- step1.1
  |   |- step1.2
  |     |- action1.2.1
  |     |- action1.2.2
  |     |- action...
  |   |- step...
  |- job2?
  |- job...

版本

actions/setup-node@74bc508 # 指向一个 commit
actions/setup-node@v1.0    # 指向一个标签
actions/setup-node@master  # 指向一个分支

on

触发条件

• 触发工作流的事件: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows

定时任务

on:
  push:
  schedule:
    - cron: '0 21 * * *'

┌───────────── minute (0 - 59)
│ ┌───────────── hour (0 - 23)
│ │ ┌───────────── day of the month (1 - 31)
│ │ │ ┌───────────── month (1 - 12 or JAN-DEC)
│ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
│ │ │ │ │
│ │ │ │ │
│ │ │ │ │
* * * * *

NOTE:

• 北京时间: 北京处于东8区 (utc + 8) % 24, 0 21 * * * 则代表 (21+8)%24 = 5 北京时间早上5点钟.
• github action 最小的执行间隔为5分钟
• Github Action 的任务一般集中设置在整点, 所以可以适当调节分钟错开使用高峰

获取时间

jobs:
  bot:
    runs-on: ubuntu-latest
    steps:
      # ...
      # prev steps
      # ...
      - name: 'Get Date'
        run: echo "REPORT_DATE=$(TZ=':Asia/Shanghai' date '+%Y-%m-%d %T')" >> $GITHUB_ENV
      - name: 'Gen Report'
        uses: someaction
        with: 
          subject: Report (${{env.REPORT_DATE}})

复用工作流

当你想复用某些工作流, 并在其中添加一些条件分支时

name: Demo

on:
  push:
    branches: [main]

jobs:
  test:
    runs-on: ubuntu-latest
    ...
    
  release:
    if: startsWith(github.ref, 'refs/tags/')
    runs-on: ubuntu-latest

环境变量与秘钥

action 提供了虚拟环境的写权限秘钥,只要在env中声明即可

#...
  env:
    GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} # 为写权限提供秘钥

其他自定义秘钥, 比如高德地图的token, 可以前往项目的 settings/Security/Secrets and variables/Actions 添加. 使用则如 GITHUB_TOKEN 一致 不需要加密的内容可以声明为 variable. 用 vars.<variable_name> 来使用

# 声明为环境变量
  env: 
    WEATHER_API_TOKEN: ${{ secrets.WEATHER_API_TOKEN }}

# 直接使用
  - name: 'Send Mail'
    uses: dawidd6/action-send-mail@master
    with: 
      server_address: smtp.qq.com
      server_port: 465
      username: ${{ vars.MAIL_USERNAME }}
      password: ${{ secrets.MAIL_PASSWORD }}

在 release 中发布

关于声明式提交

name: Release Project

# 生成 changelog 时需要写权限
permissions:
  contents: write

on: 
  push:
    tags:
      - v** # 当添加标签,并且标签以v开头时,执行下面的jobs

jobs:
  build:
    runs-on: ubuntu-latest
    env:
      GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} # 为写权限提供秘钥

    steps:
        # 拉取代码
      - name: 'Checkout codes'
        uses: actions/checkout@v3
        with:
          # 获取最新的代码, 可以减少程序消耗, 并且 changelogithub 也必须指定该参数
          fetch-depth: 0

        # 安装 node 环境
      - name: 'Install Node'
        uses: actions/setup-node@v3
        with:
          # 指定 node 版本
          node-version: 16

        # 安装项目依赖
      - name: 'Install dependencies'
        run: npm install
      - name: 'Build'
        run: npm run build

        # 根据commit信息,生成changelog, 提交规范参考 约定式提交规范
        # 只会添加 feat, fix 的提交到 changelog 中
        # 此步骤需要 `GITHUB_TOKEN`
      - name: 'Gen changelog'
        run: npx changelogithub@0.12
        
        # 压缩项目文件夹
      - name: 'Compress dist'
        run: zip -q -r dist.zip ./dist
      
        # 将目标文件上传至 release 的 assets 中
        # 此步骤需要 `GITHUB_TOKEN`
      - name: 'Upload release assets'
        uses: softprops/action-gh-release@v1
        with:
          files: |
            dist.zip

不同平台打包或编译

# ...

jobs:
  release:
    name: build and release electron app
    runs-on: ${{ matrix.os }}
    env:
      GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

    # 声明策略
    strategy:
      fail-fast: false
      matrix:
        os: [windows-latest, macos-latest]
    
    # ... checkout 
    # ... build
    - name: Cleanup Artifacts for Windows
        if: matrix.os == 'windows-latest'
        run: |
          npx rimraf "release/!(*.exe)"
      
    - name: Cleanup Artifacts for MacOS
      if: matrix.os == 'macos-latest'
      run: |
        npx rimraf "release/!(*.dmg)"

      - name: 'Gen changelog'
      run: |
        npx changelogithub@0.12

    - name: release
      uses: softprops/action-gh-release@v1
      # if: startsWith(github.ref, 'refs/tags/')
      with:
        files: |
          release/*.exe
          release/*.dmg

用 Google 邮箱发送邮件

send-mail action: https://github.com/marketplace/actions/send-email

qq mail 不让用了，还没检查是什么原因

1. 去 Google 账号开启两步验证目的是为了添加应用密码

• https://support.google.com/accounts/answer/185839?hl=en&co=GENIE.Platform%3DAndroid
• 打开您的谷歌帐户。
• 在导航面板中，选择“安全性”。
• 在“登录 Google”下方，选择两步验证开始使用 然后 。
• 按照屏幕上的步骤操作。

2. 开启专用密码，action邮箱登录需要专用密码

• https://support.google.com/accounts/answer/185833?hl=en
• 转到您的谷歌帐号。
• 选择“安全性”。
• 在“登录 Google”下方，选择两步验证。
• 在页面底部，选择“应用密码”。
• 输入一个名称，以帮助你记住应用密码的使用位置。
• 选择“生成”。
• 要输入应用密码，请按照屏幕上的说明操作。应用密码是在设备上生成的 16 个字符的代码。
• 选择“完成”。