GitLab继承作业中变量覆盖失效问题排查求助

问题场景 #

我有一个无法修改的仓库模板，其中.build作业模板定义如下：

variables:
  FOO: "foo"
  BAR: "bar"

.build:
  stage: foo-build
  script:
    - # 使用FOO、BAR变量执行操作
  rules:
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_PIPELINE_SOURCE != "schedule"

通过以下方式引入该模板：

include: 
  - project: 'foo/bar/ci-template'
    ref: master
    file: '.build.yml'

我的配置文件中还有deploy-dev作业：

deploy-dev:
  stage: deploy-dev
  needs: [ "build-foo" ]
  rules:
    - if: '$DEPLOY_TO =~ "stage:dev" || $DEPLOY_TO =~ "stage:staging" || $DEPLOY_TO =~ "stage:live"'

最后定义的build-foo作业继承自.build，尝试覆盖变量但失效：

build-foo:
  extends: .build
  needs: [ ]
  variables:
    FOO: "Override foo value"
    BAR: "Override bar value"
  # before_script:
  # - export FOO="Override foo value"
  # - export BAR="Override bar value"
  script:
    - echo "FOO $FOO"
    - echo "BAR $BAR"
  rules:
    - if: '$DEPLOY_TO =~ "stage:dev" || $DEPLOY_TO =~ "stage:staging" || $DEPLOY_TO =~ "stage:live"'

当前脚本已被覆盖，但输出的是模板中的变量值，而非build-foo中设置的覆盖值；用before_script里的export可以正常生效，但不符合预期。

问题原因 #

GitLab CI的extends继承机制中，模板里的variables属于全局模板变量，优先级高于子作业的作业级变量。当子作业和模板定义同名变量时，模板变量会被保留，子作业的变量设置被忽略，这就是覆盖失效的核心原因。

而before_script里的export能生效，是因为这是在作业运行时的Shell环境中修改变量，属于运行时层面，优先级高于CI预定义的模板变量。

解决方法 #

方法1：用!override强制覆盖（推荐） #

GitLab 15.4及以上版本支持!override关键字，可强制让子作业的变量覆盖模板中的同名变量。修改build-foo的variables部分：

build-foo:
  extends: .build
  needs: [ ]
  variables:
    FOO: !override "Override foo value"
    BAR: !override "Override bar value"
  script:
    - echo "FOO $FOO"
    - echo "BAR $BAR"
  rules:
    - if: '$DEPLOY_TO =~ "stage:dev" || $DEPLOY_TO =~ "stage:staging" || $DEPLOY_TO =~ "stage:live"'

方法2：使用项目/组级变量 #

如果无法修改作业配置，可在项目的Settings > CI/CD > Variables中添加FOO和BAR变量，项目级变量的优先级高于模板变量，会自动覆盖模板值。根据需求可设置为“Protected”或“Masked”。

方法3：优化before_script写法（备选） #

如果前两种方法不可行，可保留before_script但简化：

build-foo:
  extends: .build
  needs: [ ]
  before_script:
    - export FOO="Override foo value"
    - export BAR="Override bar value"
  script:
    - echo "FOO $FOO"
    - echo "BAR $BAR"
  rules:
    - if: '$DEPLOY_TO =~ "stage:dev" || $DEPLOY_TO =~ "stage:staging" || $DEPLOY_TO =~ "stage:live"'

内容的提问来源于stack exchange，提问作者Ali-Ibrahim