如何基于通用作业步骤构建GitLab流水线以减少重复代码？

完全可以通过拆分通用逻辑与差异化部分来实现复用，结合你提到的include、extends和!reference关键字就能高效完成。以下是具体实现方向：

1. 提取通用逻辑到模板文件 #

将两个流水线共有的作业配置、阶段定义抽离到单独的模板文件（比如templates/common.yml），通过include引入到各项目的流水线中：

• 用.common_*命名的锚点作业（以.开头的是隐藏作业，不会自动执行）定义通用配置，比如共享的镜像、before_script、标签等。
• 用.stages锚点定义通用阶段，供各项目复用或扩展。

示例通用模板：

# templates/common.yml
.common_build:
  image: node:18
  before_script:
    - npm install
  tags:
    - shared-runner

.common_test:
  extends: .common_build
  script:
    - npm run test
  artifacts:
    reports:
      junit: junit.xml

.stages:
  - build
  - test

2. 处理差异化变量 #

针对功能相同但取值不同的变量，有两种处理方式：

• 流水线文件定义：在各项目的.gitlab-ci.yml中用variables块覆盖或新增变量，通用模板直接使用变量占位（比如$BUILD_TARGET）。
• GitLab界面配置：敏感变量或需要动态调整的变量，直接在项目/组的「设置→CI/CD→变量」中配置，优先级高于流水线文件中的变量。

3. 分离独特逻辑 #

各项目的专属作业、阶段直接写在自己的流水线文件中，如需基于通用作业修改，通过extends继承后覆盖部分配置：

• 扩展通用阶段：用!reference引用通用阶段，再追加自己的专属阶段。
• 定制通用作业：继承通用作业后，用!reference复用原有配置，再添加自己的脚本或规则。

项目A示例（.gitlab-ci.yml） #

include:
  - project: 'your-group/templates'
    file: '/common.yml'

variables:
  DEPLOY_ENV: 'staging'

# 复用通用阶段并添加专属阶段
stages: !reference [.stages]
stages:
  - build
  - test
  - deploy-staging

build:
  extends: .common_build
  script:
    - !reference [.common_build, before_script] # 复用通用前置脚本
    - npm run build:staging

test:
  extends: .common_test

# 专属部署作业
deploy-staging:
  image: aws-cli:latest
  script:
    - aws s3 sync dist/ s3://$STAGING_BUCKET
  only:
    - main

项目B示例（.gitlab-ci.yml） #

include:
  - project: 'your-group/templates'
    file: '/common.yml'

variables:
  DEPLOY_ENV: 'production'

# 复用通用阶段并添加多个专属阶段
stages: !reference [.stages]
stages:
  - build
  - test
  - deploy-production
  - post-deploy-check

build:
  extends: .common_build
  script:
    - !reference [.common_build, before_script]
    - npm run build:prod

test:
  extends: .common_test
  script:
    - !reference [.common_test, script] # 复用通用测试脚本
    - npm run test:e2e # 追加专属E2E测试

# 专属生产部署作业
deploy-production:
  image: aws-cli:latest
  script:
    - aws s3 sync dist/ s3://$PROD_BUCKET
  only:
    - tags

# 专属部署后检查作业
post-deploy-check:
  script:
    - curl -f $PROD_URL/health
  needs: [deploy-production]

关键注意事项 #

• extends合并规则：子作业的配置会覆盖父作业的同名键，如需保留父作业内容，用!reference引用后追加。
• 变量优先级：GitLab界面配置的变量 > 流水线文件variables块 > 模板中的变量，可灵活控制取值。
• 模板测试：单独创建测试项目引入通用模板，验证逻辑正常后再推广到目标项目，降低维护风险。

内容的提问来源于stack exchange，提问作者user2320340