Jenkins Pipeline中如何限制只允许一个参数

57次阅读

问题描述

在Jenkins的Pipeline脚本中，我有以下带有字符串参数的脚本。如果在Jenkins中提供多个逗号分隔的输入，Target参数将会失败。我该如何限制Jenkins Pipeline仅接受一个值作为参数，而不是多个逗号分隔的值。

properties([
  parameters([
    string(defaultValue: '', description: '', name: 'ID'),
    string(defaultValue: '', description: '', name: 'Target')
  ])
])

解决方案

请注意以下操作可能因版本差异而有所不同。

最佳解决方案：使用扩展选择参数插件

对于这样的需求，最佳解决方案是使用Jenkins的扩展选择参数插件。该插件允许您在构建触发时选择参数。以下是步骤：

在Jenkins的Pipeline脚本中，使用以下代码段来定义参数：

properties([
  parameters([
    extendedChoice(
      name: 'Target',
      type: 'PT_SINGLE_SELECT',
      description: '',
      defaultValue: '',
      multiSelectDelimiter: ',',
      groovyScript: '''
        return ["option1", "option2", "option3"]
      '''
    )
  ])
])

在上面的代码中，您需要将groovyScript替换为您的选项列表。

然后，您可以在脚本中通过${Target}引用所选的参数值。

使用这种方法，您可以限制仅允许选择一个参数值，而不是多个逗号分隔的值。

方案2：手动限制参数

如果您不想使用插件，您也可以在脚本中手动限制参数。以下是一种可能的方法，但请注意，这种方法可能会在脚本中引入复杂性，并需要您自行检查输入的有效性。

properties([
  parameters([
    string(defaultValue: '', description: '', name: 'ID'),
    string(defaultValue: '', description: '', name: 'Target')
  ])
])

// 在Pipeline脚本中添加以下代码
def targetList = params.Target.split(',')
if (targetList.size() > 1) {
  error("Only one value is allowed for the 'Target' parameter.")
}

在上面的代码中，我们首先将输入的Target参数使用逗号分隔拆分成一个列表。然后，我们检查列表的大小，如果大小大于1，说明提供了多个值，我们就会抛出一个错误。

请注意，这种方法只是手动实现了限制，而不是Jenkins的内置功能。