GitLab CI手动作业预填充变量时，description元素为何不被允许？

问题背景 #

在gitlab.com上配置手动触发的CI作业，想给需要用户填写的变量加描述和默认值，完全照着官方文档《prefill variables in manual pipelines》写的，但VS Code的YAML插件和GitLab自带的CI编辑器都报错：

• 同时写description和value时提示「Property description is not allowed」
• 只写description时提示「Incorrect type. Expected one of string, number.」

报错原因 #

1. VS Code插件语法规则滞后：Red Hat的YAML插件内置的GitLab CI语法schema未更新，不支持这种带description和value的结构化变量定义，属于校验误判。
2. 变量定义不完整：GitLab要求带描述的变量必须配置默认值value，仅写description会因类型不匹配触发报错——常规变量是字符串/数字类型，突然转为对象格式会被旧校验规则识别为非法。

解决方案 #

1. 补全变量定义（必做） #

给所有带description的变量添加value默认值，修正后的代码示例：

validate-release:
  extends: .release
  stage: validate-release
  variables:
    TEST_SUITE:
      description: "要运行的测试套件，可选值：'default', 'short', 'full'."
      value: "default"
    DEPLOY_ENVIRONMENT:
      description: "选择部署目标，可选值：'canary', 'staging', 'production'或自定义稳定分支."
      value: "staging" # 添加默认值解决类型校验报错

2. 解决VS Code插件报错 #

• 更新YAML插件：在VS Code扩展市场将「YAML by Red Hat」更新至最新版，新版已支持GitLab的结构化变量定义语法。
• 手动指定最新schema：若更新后仍报错，在项目根目录的.vscode/settings.json中添加以下配置，强制使用GitLab官方最新的CI语法规则：

  {
    "yaml.schemas": {
      "https://gitlab.com/gitlab-org/gitlab/-/raw/master/app/assets/javascripts/editor/schema/ci.json": ".gitlab-ci.yml"
    }
  }
  

• 临时忽略报错：右键VS Code问题面板中的报错，选择「忽略此规则」，不影响CI实际运行。

3. 验证GitLab编辑器问题 #

补全变量定义后，即使GitLab编辑器仍显示报错，可先保存配置并触发一次手动流水线——多数情况下编辑器校验存在滞后，实际功能可正常运行。若确实无法执行，检查项目CI/CD设置是否启用了旧版配置限制。

效果验证 #

配置完成后，手动触发作业时会显示带有描述文字和默认值的变量输入框，可正常修改变量值并执行作业。

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