如何在使用 Jenkins Job DSL 插件时使种子作业失败

Question

我正在使用 Jenkins Job DSL 插件并配置了一个参数化构建的种子作业。如果有人忘记填写所需的参数之一，我想使构建失败。我的DSL脚本顶部有以下内容：

def expectedParams = [
  'BRANCH_NAME',
  'FALLBACK_BRANCH',
  'FOLDER_NAME',
  'FOLDER_DISPLAYNAME',
  'MAIL_TO'
];

boolean envChecksPass = true;
expectedParams.each {
  if (! binding.variables.get(it)?.trim()) {
      println "This script expects the $it environment variable to be set."
      envChecksPass = false;
  }
}
if (! envChecksPass) {
  // TODO: SET THE JOB STATUS TO FAILED
  return false;
}

如何完成待办事项位？显然我可以在这里抛出一个例外，但它似乎有点丑陋。什么是首选/最佳实践方法。

Answer 1

引发异常是当前的首选方法。如果抛出javaposse.jobdsl.dsl.DslException堆栈跟踪将被禁止显示，并且仅显示消息。

Answer 2

另一种方法是以非零代码退出，这会将作业结果标记为 FAILURE：

if (! envChecksPass) {
  // TODO: SET THE JOB STATUS TO FAILED
  exit 1;
}

Answer 3

在 Jenkins 管道中，最好使用"error"步骤

if (! binding.variables.get(it)?.trim()) {
    error "This script expects the $it environment variable to be set."
}

您将在日志中看到以下输出（没有堆栈 Stace）

ERROR: This script expects the USER environment variable to be set.
Finished: FAILURE