How to display info directly on build page in Jenkins?

Question

I would like to have the following workflow in Jenkins:

user clicks 'Build Now'
user fills out build parameters
user clicks 'Build'
information is generated (via a script) and presented to user along with 'Continue' button
user clicks 'Continue' button which simply triggers another job

How can this be done?

Possible duplicate of [Jenkins pipeline plugin: set the build description](https://stackoverflow.com/questions/36501203/jenkins-pipeline-plugin-set-the-build-description) — , Oct 01 '18 at 16:38

score 5 · Answer 1 · answered Apr 27 '20 at 16:43

5

in Jenkins Pipeline method use as

script{ currentBuild.displayName = Build_Display (this will be overwrite the Job number) currentBuild.description = Build_description }

answered Apr 27 '20 at 16:43

Amit AB

51
1
3

1

Although maybe this is the right answer, it's good to add some explanation. – Joao Vitorino Apr 28 '20 at 02:55

score 4 · Accepted Answer · answered Oct 02 '18 at 00:33

4

Use the Execute shell action to create a shell script that sets an environment variable. For example: echo "BUILD_DESCRIPTION=example" >BUILD_DESCRIPTION.setting.
Use the Inject environment variables action to execute the shell script.
Use the Set build description action to set the build description to the variable that was set by the shell script (eg ${BUILD_DESCRIPTION}).

answered Oct 02 '18 at 00:33

Noel Yap

18,822
21
92
144

1

I got it to work using this plugin: https://plugins.jenkins.io/description-setter/. The build description is exposed to the environment via DESCRIPTION_SETTER_DESCRIPTION. You use it in a Post Build action. – Atafar Mar 18 '20 at 10:29
Please add more details, I need this without installing any plugins. – OfusJK Jul 21 '22 at 04:26

score 3 · Answer 3 · answered Dec 02 '13 at 09:44

3

Alternatively to solution with groovy script plugin, you may generate information together with button with REST command using Rich Text Publisher Plugin - you just don't have to write groovy script, only markup.

It adds a custom html markup to build page after build had been executed. It allows to configure a message using file, or environment variables.

answered Dec 02 '13 at 09:44

OndroMih

7,280
1
26
44

This seems great, but it’s not being maintained and has a security vulnerability. – igortg Dec 25 '22 at 12:04

score 2 · Answer 4 · edited May 23 '17 at 10:30

2

Create an 'Execute system Groovy script' that updates the build description. See How to submit Jenkins job via REST API? which creates a button in the build description.

edited May 23 '17 at 10:30

Community

1
1

answered Jun 04 '12 at 16:49

Noel Yap

18,822
21
92
144

1

One issue would be that the description also shows up in the list of builds on the left, so the text can't be very big, otherwise that list of builds becomes unusable. It would be wonderful if there was another field that could be set from a system groovy script and which would be rendered live. – Christian Goetze Sep 30 '15 at 22:03
Just the first few chars in the build description appears in the builds list on the left. We set build description with initial short summary e.g. version under test and append more information which can be seen in the build summary. e.g. set from file in workspace: `def cb = Thread.currentThread().executable def ws = manager.build.workspace.getRemote() String desc = new File(ws + "/VERSION.txt").text cb.setDescription(desc)` – gaoithe Feb 20 '18 at 16:15
what's the variable to update for the build description? – Oct 01 '18 at 16:37
Did you click on the "How to submit Jenkins job via REST API?" link? It has an example of how to set the build description. – Noel Yap Oct 02 '18 at 00:25
I've also added another answer. – Noel Yap Oct 02 '18 at 00:49

score 1 · Answer 5 · answered Apr 28 '20 at 03:14

If I understand correctly, you want a 'Confirmation Button', or a 'Are you Sure' button:

In Jenkins pipeline, you can do that by asking for user input.

timeout(time: 15, unit: "MINUTES") {
    input message: 'Are the info correct?'
}

The problem with this approach is that you keep a Jenkins worker (or process) running for a maximum X minute if the user doesn't take any action, this can make Jenkins create a long queue of builds.

Here is the documentation.

score 0 · Answer 6 · edited Jun 20 '20 at 09:12

0

If i get what you want to do right (more from the caption and less from the description) you should just use this Publisher Plugin:

if it doesn't help please try adding more information to your question.

edited Jun 20 '20 at 09:12

Community

1
1

answered May 30 '12 at 21:50

eyossi

4,230
22
20

4

I looked at that plugin. All it does is create a link from the build page. I want to display info directly on the build page. – Noel Yap May 30 '12 at 22:09

How to display info directly on build page in Jenkins?

6 Answers6