Gitlab运行Pipeline时如何将指定变量设置为必填项

你可以通过以下两种方案实现变量必填校验，未赋值时阻止流水线启动：

方案1：新增前置校验Job（兼容所有GitLab版本） #

在流水线最前面增加一个预检阶段，专门校验必填变量是否为空，校验不通过直接终止流水线，后续阶段不会执行。修改后的gitlab-ci.yml示例如下：

stages:
  - pre-check # 新增的预检阶段，必须第一个执行
  - deploy
  - Script

variables:
  Domain:
    value: "dom"
  HOST_NAME:
    value: ""
  JAVA_FILES_WITH_ARGS:
    value: ""

# 预检Job
check_required_vars:
  stage: pre-check
  script:
    # 校验HOST_NAME是否为空
    - if [ -z "$HOST_NAME" ]; then echo "错误：必填变量HOST_NAME未赋值" && exit 1; fi
    # 校验JAVA_FILES_WITH_ARGS是否为空
    - if [ -z "$JAVA_FILES_WITH_ARGS" ]; then echo "错误：必填变量JAVA_FILES_WITH_ARGS未赋值" && exit 1; fi
    - echo "所有必填变量校验通过"
  # 所有触发流水线的场景都要执行校验
  rules:
    - when: always

后续的deploy、Script阶段的Job不需要额外修改，只要预检Job执行失败，全流水线都会自动终止。

方案2：使用GitLab原生必填变量配置（GitLab 15.7及以上版本适用） #

如果你的GitLab版本在15.7以上，可以直接在CI配置的变量定义中添加required: true标记，GitLab会在流水线启动前自动校验，未填必填变量时直接无法启动流水线，不需要额外写校验逻辑。配置示例如下：

stages:
  - deploy
  - Script

variables:
  Domain:
    value: "dom"
  HOST_NAME:
    value: ""
    description: "服务部署的主机名，必填项"
    required: true # 标记为必填
  JAVA_FILES_WITH_ARGS:
    value: ""
    description: "带启动参数的Java文件路径，必填项"
    required: true # 标记为必填

配置后手动触发流水线时，未填写的必填变量会在触发页面高亮提示，自动触发场景下缺少必填变量会直接拒绝启动流水线。

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