Github Actions

December 14, 2022

https://github.com/features/actions
https://docs.github.com/actions
https://www.actionsbyexample.com/

Github Actions 是一个 CI/CD 平台

Quickstart

配置文件置于.github/workflows目录，文件名任意，后缀需为.yml 语法文档

yaml

# https://docs.github.com/actions/learn-github-actions/understanding-github-actions

name: GitHub Actions Demo
run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
on: [push, workflow_dispatch]

jobs:
    Explore-GitHub-Actions:
        runs-on: ubuntu-latest
        steps:
            - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
            - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
            - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
            - name: Check out repository code
              uses: actions/checkout@v3
            - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
            - run: echo "🖥️ The workflow is now ready to test your code on the runner."
            - name: List files in the repository
              run: |
                  ls ${{ github.workspace }}
            - run: echo "🍏 This job's status is ${{ job.status }}."

流程

https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions

每一个 yaml 文件配置了一个 workflow

指定的 events 触发 workflow 的运行（所有 events）

jobs 是一组 steps 的集合，这组 steps 运行于同一个 runner 环境下（参见）

step 可以是 shell 命令，亦或是 actions

actions 是特殊的 step，类似于函数，允许提供参数来调用（参见）

runner 实际上就是运行的操作系统类型（例如： windows-latest ubuntu-latest macos-latest）

示例

参考：https://github.com/actions/starter-workflows/blob/main/pages/static.yml

以下是一个部署 hexo 的示例，首先需要在 repo 中设置好 pages 从 actions 部署

然后，假设目录名为 repo，创建 repo/.github/workflows/pages.yml 文件，内容如下

yaml

# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
    # Runs on pushes targeting the default branch
    push:
        branches: ["main"]

    # Allows you to run this workflow manually from the Actions tab
    workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
    contents: read
    pages: write
    id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
    group: "pages"
    cancel-in-progress: false

jobs:
    # Single deploy job since we're just deploying
    deploy:
        environment:
            name: github-pages
            url: ${{ steps.deployment.outputs.page_url }}
        runs-on: ubuntu-latest
        steps:
            - name: Checkout
              uses: actions/checkout@v4

            - name: Setup Node.js
              uses: actions/setup-node@v4

            - name: Node.js
              run: node -v

            - name: Npm install
              run: npm install

            - name: Npm build
              run: npm run build

            - name: Setup Pages
              uses: actions/configure-pages@v3

            - name: Upload artifact
              uses: actions/upload-pages-artifact@v1
              with:
                  # Upload ./public
                  path: "public"

            - name: Deploy to GitHub Pages
              id: deployment
              uses: actions/deploy-pages@v2