Movatterモバイル変換

测试 GitHub 工作流，一些比较特殊的玩儿法。

基本概念

GitHub actions 有四个基本的概念，如下：

• workflow （工作流程）：持续集成一次运行的过程，就是一个 workflow。
• job （任务）：一个 workflow 由一个或多个 jobs 构成，含义是一次持续集成的运行，可以完成多个任务。
• step（步骤）：每个 job 由多个 step 构成，一步步完成。
• action （动作）：每个 step 可以依次执行一个或多个命令（action）。

配置文件

GitHub Actions 采用YAML 格式的配置文件叫做 workflow 文件，存放在代码仓库的.github/workflows 目录。文件名可以任意取，但是后缀名统一为.yml，比如ci.yml。一个库可以有多个workflow 文件。GitHub 只要发现.github/workflows 目录里面有.yml 文件，就会根据配置事件自动运行该文件。

name: GitHub Actions Demoon:push:branches:- mainjobs:build:runs-on: ubuntu-18.04steps:-uses: actions/checkout@v3-uses: actions/setup-node@v3with:node-version:16-run: npm install-run: npm run build

定触条件

on 字段指定触发workflow 的条件，通常是某些事件。

# push 事件触发 workflowon: push# push 事件或 pull_request 事件都可以触发 workflowon:[push, pull_request]# 只有在 main 分支 push 事件触发 workflowon:push:branches:- main# push 事件触发 workflow，但是 docs 目录下的更改 push 事件不触发 workflowon:push:paths-ignore:-'docs/**'# push 事件触发 workflow，# 包括 sub-project 目录或其子目录中的文件，触发 workflow# 除非该文件在 sub-project/docs 目录中，不触发 workflowon:push:paths:-'sub-project/**'-'!sub-project/docs/**'# 版本发布为 published 时运行工作流程。on:release:types:[published]

多项任务

通过jobs (jobs.<job_id>.name)字段，配置一项或多项需要执行的任务。

jobs:my_first_job:name: My first jobmy_second_job:name: My second job

多项任务依赖关系

通过needs (jobs.<job_id>.needs)字段，指定当前任务的依赖关系。

jobs:job1:job2:needs: job1job3:needs:[job1, job2]

上面配置中，job1 必须先于job2 完成，而job3 等待job1 和job2 的完成才能运行。因此，这个 workflow 的运行顺序依次为：job1、job2、job3。

多项任务传递参数

jobs:job1:runs-on: ubuntu-latest# Map a step output to a job outputoutputs:output1: ${{ steps.step1.outputs.test}}output2: ${{ steps.step2.outputs.test}}steps:-id: step1run: echo "::set-output name=test::hello"-id: step2run: echo "::set-output name=test::world"job2:runs-on: ubuntu-latestneeds: job1steps:-run: echo ${{needs.job1.outputs.output1}} ${{needs.job1.outputs.output2}}

指定每项任务的虚拟机环境

runs-on 字段指定运行所需要的虚拟机环境。⚠️ 它是必填字段。

runs-on: ubuntu-18.04

jobs:build:runs-on: ubuntu-18.04

指定每项任务的步骤

steps 字段指定每个 Job 的运行步骤，可以包含一个或多个步骤。每个步骤都可以指定以下三个字段。

jobs.<job_id>.steps.name：步骤名称。jobs.<job_id>.steps.run：该步骤运行的命令或者 action。jobs.<job_id>.steps.env：该步骤所需的环境变量。

jobs:build:runs-on: ubuntu-18.04steps:-uses: actions/checkout@v3-uses: actions/setup-node@v3with:node-version:16registry-url:'https://registry.npmjs.org'-run: npm install-run: npm run build

一个工作流完成触发另外一个工作流

# ci.ymlname: Node.js CIon: pushjobs:test:# Containers must run in Linux based operating systemsruns-on: ubuntu-lateststeps:-uses: actions/checkout@v3-uses: actions/setup-node@v3with:node-version:16-name: Install dependenciesrun: npm installtrigger_tests:needs: testruns-on: ubuntu-lateststeps:-name: Trigger testsuses: actions/github-script@v6with:script:|            const res = await github.rest.repos.createDispatchEvent({              owner: 'jaywcjlove',              repo: 'typenexus',              event_type: 'run-deploy'            });env:GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN}}

上面ci.yml 工作流执行完成之后，触发main.yml，注意上面的run-deploy 取名保持一致

# main.ymlname: deployon:repository_dispatch:types:[run-deploy]jobs:build:runs-on: ubuntu-lateststeps:-uses: actions/checkout@v3

常用实例

获取版本信息

-name: Testrun:|    # Strip git ref prefix from version    echo "${{ github.ref }}"    # VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')# # Strip "v" prefix from tag name# [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')    echo "$VERSION"

name: CIon:push:tags:- v*jobs:create-docker-image:runs-on: ubuntu-lateststeps:-uses: actions/checkout@master# 向 EVN 写入 CURRENT_VERSION 环境变量赋值版本号-run:|          echo "CURRENT_VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV# 可以获取到 CURRENT_VERSION 的值-run: echo "${{env.CURRENT_VERSION}}"

通过 commit 跳过任务

jobs:build:if:"!contains(github.event.head_commit.message, 'skip ci')"

获取是否存在 Tag

-run: echo "previous_tag=$(git describe--tags--abbrev=0 2>/dev/null|| echo '')">> $GITHUB_ENV-name: Generate changelogid: changeloguses: jaywcjlove/changelog-generator@mainif: env.previous_tag

修改 package.json

-name: Modify Versionshell: bashrun:|    node -e 'var pkg = require("./package.json"); pkg.version= (new Date().getFullYear().toString().substr(2)) + "." + (new Date().getMonth() + 1) + "." + (new Date().getDate()); require("fs").writeFileSync("./package.json", JSON.stringify(pkg, null, 2))'

提交到 gh-pages 分支

-name: Deployuses: peaceiris/actions-gh-pages@v3with:github_token: ${{ secrets.GITHUB_TOKEN}}publish_dir: ./build

克隆带有 Submodule 的仓库

-name: Checkoutuses: actions/checkout@v3with:path: mainsubmodules:true

submodules：true 检出子模块或recursive 递归检出子模块。

-name: Clone sub repositoryshell: bashrun:|    auth_header="$(git config --local --get http.https://github.com/.extraheader)"    # git submodule sync --recursive    # git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --remote --force --recursive --checkout ant.design

步骤依赖作业

使用jobs.<job_id>.needs 识别在此作业运行之前必须成功完成的任何作业。它可以是一个字符串，也可以是字符串数组。 如果某个作业失败，则所有需要它的作业都会被跳过，除非这些作业使用让该作业继续的条件表达式。

jobs:job1:job2:needs: job1job3:needs:[job1, job2]

在此示例中，job1 必须在job2 开始之前成功完成，而job3 要等待job1 和job2 完成。

此示例中的作业按顺序运行：

❶ job1❷ job2❸ job3

jobs:job1:job2:needs: job1job3:if: ${{ always()}}needs:[job1, job2]

在此示例中，job3 使用always() 条件表达式，因此它始终在job1 和job2 完成后运行，不管它们是否成功。

步骤作业文件共享

Artifacts 是 GitHub Actions 为您提供持久文件并在运行完成后使用它们或在作业（文档）之间共享的一种方式。

要创建工件并使用它，您将需要不同的操作：上传和下载。 要上传文件或目录，您只需像这样使用它：

steps:-uses: actions/checkout@v2-run: mkdir-p path/to/artifact-run: echo hello> path/to/artifact/world.txt-uses: actions/upload-artifact@v2with:name: my-artifactpath: path/to/artifact/world.txt

然后下载artifact 以使用它：

steps:-uses: actions/checkout@v2-uses: actions/download-artifact@v2with:name: my-artifact

提交 NPM 包

-run: npm publish--access publicenv:NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

获取NPM_TOKEN，可以通过npm 账号创建token

npm token list[--json|--parseable]# 查看npm token create[--read-only][--cidr=1.1.1.1/24,2.2.2.2/16]# 创建npm token revoke<id|token># 撤销

提交 docker 镜像

# https://www.basefactor.com/github-actions-docker-name: Docker loginrun: docker login-u ${{ secrets.DOCKER_USER}}-p ${{ secrets.DOCKER_PASSWORD}}-name: Build ant.design imagerun:|    cd ./ant\.design    docker build -t ant.design .-name: Tags & Push docsrun:|    # Strip git ref prefix from version    VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')# Strip "v" prefix from tag name[[ "${{ github.ref}}" == "refs/tags/"*]]&& VERSION=$(echo $VERSION| sed-e 's/^v//')    docker tag ant.design ${{ secrets.DOCKER_USER}}/ant.design:$VERSION    docker tag ant.design ${{ secrets.DOCKER_USER}}/ant.design:latest    docker push ${{ secrets.DOCKER_USER}}/ant.design:$VERSION    docker push ${{ secrets.DOCKER_USER}}/ant.design:latest

提交 commit 到 master 分支

-name: 生成一个文件，并将它提交到 master 分支run:|    # Strip git ref prefix from version    VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')    COMMIT=released-${VERSION}    # Strip "v" prefix from tag name    [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')    echo "输出版本号：$VERSION"    # 将版本输出到当前 VERSION 文件中    echo "$VERSION" > VERSION    echo "1. 输出Commit：$commit"    echo "2. Released $VERSION"    git fetch    git config --local user.email "action@github.com"    git config --local user.name "GitHub Action"    git add .    git commit -am $COMMIT    git branch -av    git pull origin master-name: 将上面的提交 push 到 master 分支uses: ad-m/github-push-action@masterwith:github_token: ${{ secrets.GITHUB_TOKEN}}

Node.js

-name: Setup Nodeuses: actions/setup-node@v2with:node-version:18

jobs:test:# Containers must run in Linux based operating systemsruns-on: ubuntu-lateststrategy:matrix:node-version:[16.x, 18.x, 20.x]steps:-uses: actions/checkout@v3-name: Use Node.js ${{ matrix.node-version}}uses: actions/setup-node@v3with:node-version: ${{ matrix.node-version}}-run: npm ci-run: npm run build--if-present-run: npm test

同步 Gitee

-name: Sync to Giteerun:|    mirror() {      git clone "https://github.com/$1/$2"      cd "$2"      git remote add gitee "https://jaywcjlove:${{ secrets.GITEE_TOKEN }}@gitee.com/uiw/$2.git"      git remote set-head origin -d      git push gitee --prune +refs/remotes/origin/*:refs/heads/* +refs/tags/*:refs/tags/*      cd ..    }    mirror uiwjs uiw

环境变量

默认环境变量

强烈建议操作使用环境变量访问文件系统，而非使用硬编码的文件路径。 GitHub 设置供操作用于所有运行器环境中的环境变量。

默认环境变量

自定义环境变量

注：GitHub 会保留GITHUB_ 环境变量前缀供GitHub 内部使用。 设置有GITHUB_ 前缀的环境变量或密码将导致错误。

在https://github.com/<用户名>/<项目名称>/settings/secrets 中添加secretsNODE_API_TOKEN，在工作流中设置环境变量NODE_API_TOKEN

-name: 测试 nodejs 获取环境变量env:NODE_API_TOKEN: ${{ secrets.NODE_API_TOKEN}}run: npm run env

Github 上下文

Github 上下文

Contributors

As always, thanks to our amazing contributors!

Made withaction-contributors.

License

Licensed under the MIT License.