Jenkins 构建下游项目时参数化触发

• Parameterized Trigger
  • 用作构建步骤
  • 在 Matrix 作业中使用插件
    • 后期构建任务
    • 构建步骤
  • 为该插件提供其他参数类型的插件
  • 向后兼容 2.22 版
  • 解决方法

Parameterized Trigger

官网地址：Parameterized Trigger

此插件可让您在构建完成时触发新构建，并通过多种方式为新构建指定参数。

当您查看触发它们的项目时，这些新构建在 Jenkins UI 中显示为 “子项目”。

您可以添加多个配置：每个配置都有一个要触发的项目列表、何时触发它们的条件（基于当前构建的结果）和一个参数部分。

如果您想在不同的远程 Jenkins 控制器上触发构建，还有一个参数化远程触发插件。

参数部分可以包含以下一项或多项的组合：

• 一组预定义的属性
• 从触发构建的工作区读取的属性文件中的属性
• 当前构建的参数
• Subversion 修订版：确保触发的项目是使用与触发构建相同的修订版构建的。您仍然必须确保这些项目实际配置为签出正确的 Subversion URL。
• 将矩阵执行限制为子集：允许您指定与在矩阵项目配置中使用的相同的组合过滤器表达式，并进一步限制要运行的下游矩阵构建的子集。

参数部分本身是可插入的，其他插件可以贡献其他参数来源。

这种触发机制既可以用作构建后步骤，也可以用作构建步骤，在这种情况下，您还可以阻止触发构建的完成。这使您可以创建类似语义的 “函数调用”。

警告：您必须通过此项目是参数化属性在下游作业中定义参数。例如：如果 job1 传递 ABC=123 给 job2，则在 job2 中将作业标记为 This project is parameterized 并添加一个名为 ABC 的参数。

用作构建步骤

当在另一个项目项上使用触发器/调用时。

如果触发器配置为启用 “阻止直到触发的项目完成其构建”，则以下环境变量可用于进一步的构建步骤。

未来构建步骤的环境变量：

• LAST_TRIGGERED_JOB_NAME- 上一个项目开始
• TRIGGERED_BUILD_NUMBER_<project name>- 上次触发的内部版本号（自 2.17 起）
• TRIGGERED_JOB_NAMES- 所有触发项目的逗号分隔列表
• TRIGGERED_BUILD_NUMBERS_<project name>- 逗号分隔的版本号列表触发
• TRIGGERED_BUILD_RESULT_<project name>- 项目的最后触发构建结果
• TRIGGERED_BUILD_RESULT_<project name>*RUN*<build number>- 构建编号的触发构建结果
• TRIGGERED_BUILD_RUN_COUNT_<project name>- 为项目触发的构建数量

从 2.17 开始：所有项目名称的字符都不是 a-zA-Z 或 0-9 替换为：_(multiple characters are condensed into a single)。

请注意，使用 BuildStep 可以将变量用于项目名称 IE ${projectName}。

在 Matrix 作业中使用插件

后期构建任务

当使用触发参数化构建作为矩阵作业的构建后任务时，将在所有不同的矩阵配置完成后完成一次触发。在这种情况下，某些环境变量可能无法解析，因为将它们传递给下游作业将失败。您也不能使用变量作为下游项目名称。如果需要此功能，则必须使用 BuildStep。

应该可用的环境变量是默认的 shell 变量（<yourserver:port>/env-vars.html）和定义为参数的变量。其他插件作为构建包装器添加的变量可能不可用。

构建步骤

当使用触发器参数化构建作为构建步骤时，它将为每个不同的配置调用，因此如果触发另一个没有参数的项目，它将执行与您的配置相同的次数，可能导致触发的作业运行多次.

但是，这也允许您使用与当前配置相关的参数触发其他作业，即在具有相同 JDK 的同一节点上触发构建。

为该插件提供其他参数类型的插件

• Git Plugin
• NodeLabel Parameter Plugin

向后兼容 2.22 版

• 从 Parameterized Trigger 2.23 开始，在某些情况下，Parameterized Trigger 无法触发下游构建，而 Parameterized Trigger <= 2.22 可以成功触发这些构建。

  • 这是由参数化触发器 2.23 中引入的新行为引起的。它不直接将参数值传递给下游构建，而是传递给下游项目的参数定义。这使参数定义能够执行其特定的过程，例如：使用 NodeLabel 参数插件选择节点。

• 示例：有一个带有选项 A、B、C 选项的项目参数。当您使用参数值 D 触发该项目时，它会在上游失败并显示以下输出：

  java.lang.IllegalArgumentException: Illegal choice: D at
  hudson.model.ChoiceParameterDefinition.checkValue(ChoiceParameterDefinition.java:72)
  

• 这被视为指定行为。

  • 因为这些故障是由参数定义设计的。例如：choice 参数被设计为不接受意外值。
  • 当您使用 Jenkins CLI 或远程访问 API 触发这些构建时，您将面临同样的问题。

• 建议修复您的项目配置以使参数定义不会失败。

  • 例如，使用 EnvInject 插件来处理值或使用可扩展选择参数插件，它提供了一个接受编辑值的选择参数。

解决方法

作为向后兼容性，您可以通过将 Java 系统属性设置 hudson.plugins.parameterizedtrigger.ProjectSpecificParametersActionFactory.compatibility_mode 为 true。可以通过启动 Jenkins 来完成，如下所示：

java -Dhudson.plugins.parameterizedtrigger.ProjectSpecificParametersActionFactory.compatibility_mode=true -jar jenkins.war

在 RedHat Linux 系统中，您可以修改 /etc/sysconfig/jenkins 如下：

-JENKINS\_JAVA\_OPTIONS="-Djava.awt.headless=true"
+JENKINS\_JAVA\_OPTIONS="-Djava.awt.headless=true -Dhudson.plugins.parameterizedtrigger.ProjectSpecificParametersActionFactory.compatibility_mode=true"

在 Debian Linux 系统中，您可以修改 /etc/defaults/jenkins 如下：

-JAVA_ARGS="-Djava.awt.headless=true" # Allow graphs etc. to work even when an X server is present
+JAVA_ARGS="-Djava.awt.headless=true -Dhudson.plugins.parameterizedtrigger.ProjectSpecificParametersActionFactory.compatibility_mode=true"

在 Windows 系统中，可以修改安装文件夹中的 jenkins.xml。

-<arguments>-Xrs -Xmx256m -Dhudson.lifecycle=hudson.lifecycle.WindowsServiceLifecycle -jar "%BASE%\\jenkins.war" --httpPort=8080\</arguments>
+\<arguments>-Xrs -Xmx256m -Dhudson.lifecycle=hudson.lifecycle.WindowsServiceLifecycle -Dhudson.plugins.parameterizedtrigger.ProjectSpecificParametersActionFactory.compatibility_mode=true -jar "%BASE%\\jenkins.war" --httpPort=8080\</arguments>