如何区分Jenkins管道中的构建触发器

Question

我希望在我的Jenkinsfile中添加一个条件阶段，该阶段根据构建的触发方式运行。目前，我们设置为构建由以下方式触发：

1. 对 git 存储库的更改，这些更改是在分支索引中选取的
2. 用户使用 UI 中的“立即生成”按钮手动触发生成。

是否有任何方法可以根据这些操作中的哪些操作触发了构建来运行不同的管道步骤？

Answer 1

在没有currentBuild.rawBuild访问的JenkinsPipeline中，可以通过以下方式检索构建原因：

// started by commit
currentBuild.getBuildCauses('jenkins.branch.BranchEventCause')
// started by timer
currentBuild.getBuildCauses('hudson.triggers.TimerTrigger$TimerTriggerCause')
// started by user
currentBuild.getBuildCauses('hudson.model.Cause$UserIdCause')

您可以使用以下方式获取布尔值：

isTriggeredByTimer = !currentBuild.getBuildCauses('hudson.triggers.TimerTrigger$TimerTriggerCause').isEmpty()

或者，当< code>getBuildCauses()返回一个数组时，数组的大小将与Groovy truthy语义一起正确工作:

if (currentBuild.getBuildCauses('hudson.triggers.TimerTrigger$TimerTriggerCause')) {

Answer 2

获取工作流运行原因的能力已在2.22版（2018年11月2日）中发布到支持管道的API插件中。JENKINS-41272中请求了该功能。

该版本向< code>currentBuild全局变量添加了两个方法:

< code>getBuildCauses

• 返回当前生成的生成原因的JSON数组

实验性-可能会更改< code > getBuildCauses(String cause class)

• 获取一个表示完全限定的原因类的字符串，并返回由该类型过滤的当前构建原因的JSON数组，如果没有指定类型的原因适用于当前构建，则返回一个空JSON数组

以及我提交的一个例子：

echo "${currentBuild.buildCauses}" // same as currentBuild.getBuildCauses()
echo "${currentBuild.getBuildCauses('hudson.model.Cause$UserCause')}"
echo "${currentBuild.getBuildCauses('hudson.triggers.TimerTrigger$TimerTriggerCause')}"

和输出：

[Pipeline] echo
[[_class:hudson.model.Cause$UserIdCause, shortDescription:Started by user anonymous, userId:null, userName:anonymous], [_class:org.jenkinsci.plugins.workflow.cps.replay.ReplayCause, shortDescription:Replayed #12]]
[Pipeline] echo
[]
[Pipeline] echo
[]
[Pipeline] End of Pipeline
Finished: SUCCESS

注

currentBuild似乎存在问题。GetBuildCause（type）当＜code＞类型currentBuild.GetBuildCause（'org.jenkinsci.plugins.workflow.cps.replay.ReplayCause'）失败，出现java.lang.ClassNotFoundException。JENKINS-54673中报告了管道的2.22版本：支持API（工作流支持）插件。据报道，它已在＜code＞2.24＜/code＞版本中修复。

Answer 3

以下代码应该用于确定用户是否已启动管道或计时器/其他触发器：

def isStartedByUser = currentBuild.rawBuild.getCause(hudson.model.Cause$UserIdCause) != null