GitLab CI/CD流水线运行时自定义变量未注入替换问题咨询

GitLab CI变量未注入问题排查方案 #

• 确认GitLab后台CI/CD变量配置的开关状态：如果变量勾选了「仅受保护分支可用」，而运行流水线的分支不属于受保护分支，会导致变量无法读取；如果勾选了「屏蔽变量」，变量值仅在未开启调试日志的流水线中生效，且值不能包含GitLab限制的特殊字符。
• 检查.gitlab-ci.yml中变量引用格式：在script段的shell命令中引用变量时，不要用单引号包裹${变量名}格式的引用，单引号会阻止shell对变量做替换，需使用双引号包裹或者不包裹。
• 排除变量名冲突：GitLab CI变量优先级为「手动触发流水线时临时传入的变量 > 后台CI/CD页面配置的变量 > .gitlab-ci.yml文件中定义的变量」，如果yml中定义了同名变量，会覆盖后台配置的变量值。

单个变量配置多值的实现方法 #

如果需要为单个变量配置多个可选值，GitLab 13.7及以上版本支持通过options字段定义下拉选项，配置示例如下：

variables:
  ENV:
    value: "dev" # 默认值
    description: "流水线运行环境"
    options: # 可选值列表，手动触发流水线时可下拉选择
      - "dev"
      - "test"
      - "prod"
  Category:
    value: "smoke"
    description: "测试执行分类"
    options:
      - "smoke"
      - "regression"
      - "full"

如果需要同时传入多个值到同一个变量中使用，可以用指定分隔符拼接的方式定义，运行时在script段拆分使用即可：

variables:
  Category:
    value: "smoke,api,ui"
    description: "多个测试分类用英文逗号分隔"

script段拆分多值变量的示例：

script:
  - IFS=',' read -ra CATE_LIST <<< "$Category"
  - for cate in "${CATE_LIST[@]}"; do echo "当前执行测试分类：${cate}"; done
  - pip install --upgrade pip
  - cd ./TestAutomation
  - pip install -r ./requirements.txt

变量注入验证方法 #

你可以在script段最开头添加变量打印命令，直接确认变量是否被正确注入：

script:
  - echo "ENV变量值为：$ENV"
  - echo "Category变量值为：$Category"
  # 其他后续命令

运行流水线后查看对应任务的执行日志，即可确认变量是否被正确替换。

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