从 Jenkinsfile 设置管道名称和描述

Question

我正在尝试将 jenkins 管道作为代码进行 poc。我正在使用 Github 组织文件夹插件来扫描 Github 组织并为每个分支创建作业。有没有办法明确定义从 Jenkinsfile 获得的管道作业的名称？我还想为这些工作添加一些描述。

Answer 1

您需要使用currentBuild，如下所示。 node 部分很重要

node {
    currentBuild.displayName = "$yournamevariable-$another"
    currentBuild.description = "$yourdescriptionvariable-$another"
}

编辑：上面的一个重命名构建，原始问题是关于重命名工作。 管道中的以下脚本将执行此操作（这需要适当的权限）

item = Jenkins.instance.getItemByFullName("originalJobName")
item.setDescription("This description was changed by script")
item.save()
item.renameTo("newJobName")

Answer 2

我参加这个聚会迟到了，但是这个问题迫使我参加了今天大部分时间都在#jenkins 聊天。我要感谢那次聊天中的 @tang^ 帮助我以一种优雅的方式解决了这个问题。

要在多分支 DECLARATIVE 管道中为子级设置 JOB 描述和 JOB 显示名称，请在阶段中使用以下步骤块：

steps {
    script {
        if(currentBuild.rawBuild.project.displayName != 'jobName') {
            currentBuild.rawBuild.project.description = 'NEW JOB DESCRIPTION'
            currentBuild.rawBuild.project.setDisplayName('NEW JOB DISPLAY NAME')
        }
        else {
            echo 'Name change not required'
        }
    }
}

这将要求您通过 Jenkins 沙盒批准方法批准各个脚本调用，但它比我在网络上找到的关于重命名父管道的实际子级的任何其他方法都简单得多。最后要注意的是，这应该在 Jenkinsfile 中工作，您可以在其中使用环境变量来操作正在设置的作业项。

Answer 3

我尝试使用已接受答案中的代码 sn-p 在 Jenkinsfile 中描述我的 Jenkins 管道。我必须使用 @NonCPS 注释将代码 sn-p 包装到函数中，并将 def 用于项目变量。我已将代码 sn-p 放在 Jenkinsfile 的根目录中，而不是节点部分。

@NonCPS 
def setDescription() { 
    def item = Jenkins.instance.getItemByFullName(env.JOB_NAME) 
    item.setDescription("Some description.") 
    item.save()
}

setDescription()