如何让GitLab流水线中出错的Node脚本返回失败状态？

问题场景 #

在GitLab流水线执行npx orval命令时，即便Swagger Schema验证触发SyntaxError（如下输出），命令仍返回退出码0，导致流水线被标记为成功，不符合预期（应该失败）。

流水线配置：

stages:
  - validate

image: node:latest

verify:
  stage: validate
  script:
    - 'npm i'
    - 'npx orval --config ./orval.config.js'
  artifacts:
    when: always
    paths:
      - src/ 

Orval错误输出：

🍻 Start orval v6.15.0 - A swagger client generator for typescript
dispo-file: Cleaning output folder
⚠️ SyntaxError: Swagger schema validation failed.
#/paths/~1disposition/get/parameters/0/schema/type must be equal to one of the allowed values
#/paths/~1disposition/get/parameters/0/schema must have required property '$ref'
#/paths/~1disposition/get/parameters/0/schema must match exactly one schema in oneOf
#/paths/~1disposition/get/parameters/0 must have required property '$ref'
#/paths/~1disposition/get/parameters/0 must match exactly one schema in oneOf

🎉 dispo-file - Your OpenAPI spec has been converted into ready to use orval!

解决方案1：开启Orval严格模式 #

Orval默认在验证出错时会继续生成代码并返回成功状态，在orval.config.js中添加strict: true配置，让工具在验证失败时返回非0退出码：

module.exports = {
  // 全局生效的配置
  strict: true,
  // 也可针对单个生成项单独配置
  'dispo-file': {
    input: './your-openapi-spec.yaml',
    output: './src/api',
    strict: true
  }
};

解决方案2：在GitLab脚本中强制拦截错误 #

如果修改配置后问题仍存在，可直接在流水线脚本中手动处理失败场景：

方式A：强制命令失败时退出 #

修改脚本，让npx orval命令出错时直接触发流水线失败：

script:
  - 'npm i'
  - 'npx orval --config ./orval.config.js || exit 1'

方式B：检查输出中的错误关键词 #

捕获命令输出，判断是否包含错误关键词，存在则主动退出：

script:
  - 'npm i'
  - |
    orval_output=$(npx orval --config ./orval.config.js)
    echo "$orval_output"
    # 检测输出是否包含SyntaxError关键词
    if echo "$orval_output" | grep -q "SyntaxError"; then
      exit 1
    fi

解决方案3：升级Orval版本 #

当前使用的v6.15.0可能存在退出码处理的bug，尝试升级到最新稳定版：

script:
  - 'npm i orval@latest --save-dev'
  - 'npx orval --config ./orval.config.js'

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