如何在所有分支中复用GitHub Actions工作流文件?
实现GitHub Actions工作流的集中管理,避免多分支重复维护
方法1:用工作流调用(Workflow Call)
这是GitHub官方推荐的集中管理方案,把核心工作流逻辑存在master分支,其他分支只保留一个极简的调用文件就行。
- 先在master分支的
.github/workflows/下创建通用工作流文件,比如common-ci.yml,把所有构建、测试、部署步骤都写在这里:
name: 通用CI工作流 on: workflow_call # 标记这是可被其他工作流调用的模板 jobs: ci-pipeline: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: 安装Node.js uses: actions/setup-node@v4 with: node-version: '18' - name: 安装依赖 run: npm ci - name: 代码检查 run: npm run lint - name: 构建与测试 run: | npm run build npm run test
- 然后在其他分支(比如release/v2.x、dev/login-feature)的
.github/workflows/下创建调用文件,比如ci.yml,内容就几行:
name: 分支CI流程 on: [push, pull_request] # 按需设置触发条件 jobs: run-common-ci: uses: ./.github/workflows/common-ci.yml@master # 直接调用master分支的通用工作流
后续要修改工作流逻辑,只需要更新master分支的common-ci.yml,所有分支的CI都会自动使用最新的逻辑,不用逐个分支改文件。
方法2:用复合动作(Composite Actions)
如果你的工作流里有一些可拆分的通用步骤(比如安装依赖、代码检查),可以把这些步骤封装成复合动作,存在master分支,其他分支工作流直接引用这些动作。
- 在master分支创建
.github/actions/common-steps/action.yml,把通用步骤封装进去:
name: '通用CI步骤集合' runs: using: 'composite' steps: - name: 安装Node.js uses: actions/setup-node@v4 with: node-version: '18' shell: bash - name: 安装依赖 run: npm ci shell: bash - name: 代码检查 run: npm run lint shell: bash
- 其他分支的工作流里引用这个复合动作:
name: 分支专属CI on: [push, pull_request] jobs: build-test: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: ./.github/actions/common-steps@master # 引用master分支的复合动作 - name: 分支专属构建 run: npm run build:dev - name: 分支专属测试 run: npm run test:dev
这种方式更灵活,适合通用步骤和分支专属步骤结合的场景。
额外提示
- 调用通用资源时,除了指定
@master,也可以用标签(比如@v1.0.0)来固定版本,避免master分支的更新意外影响稳定分支的CI。 - 如果不同分支需要自定义参数,可以在通用工作流/动作里定义
inputs,调用时通过with传递参数。比如通用工作流里加:
调用时就可以传自定义版本:on: workflow_call: inputs: node-version: type: string default: '18'uses: ./.github/workflows/common-ci.yml@master with: node-version: '20'
内容的提问来源于stack exchange,提问作者encrypted name
相关产品推荐
相关产品推荐

