[JIRA] (JENKINS-60299) Make build description in build history widget configurable or possible to hide

49 views
Skip to first unread message

peder.schmedling@dsb.no (JIRA)

unread,
Nov 27, 2019, 6:04:03 AM11/27/19
to jenkinsc...@googlegroups.com
Peder Schmedling created an issue
 
Jenkins / Improvement JENKINS-60299
Make build description in build history widget configurable or possible to hide
Issue Type: Improvement Improvement
Assignee: Unassigned
Attachments: image-2019-11-27-12-00-28-106.png, image-2019-11-27-12-01-21-459.png
Components: core
Created: 2019-11-27 11:03
Environment: Jenkins ver. 2.205, reproduced in browsers Chrome stable, Firefox and Edge Beta (insider preview)
Priority: Minor Minor
Reporter: Peder Schmedling

This relates to JENKINS-19760 and JENKINS-31209 resolved by https://github.com/jenkinsci/jenkins/pull/4209 where build description in build history widget is no longer truncated. A regression of this is that for elaborate build descriptions the build history widget becomes unusable.

The change did not sit well with our organization as our build descriptions are quite extensive. We use groovy code to parse log output which results in a big html blob containing details about versions, servers, errors, warns git commit and details, related jira issues etc. This html is then used as build description which results in nice reports when the user views the job details:

The issue after the change realted to JENKINS-19760 and JENKINS-31209 is that this full html report is also displayed in the build history widget:

Possible solutions:

  • Have truncation length (maxDescrLength) configurable.
  • Possibility to hide build description in build history widget.
Add Comment Add Comment
 
This message was sent by Atlassian Jira (v7.13.6#713006-sha1:cc4451f)
Atlassian logo

peder.schmedling@dsb.no (JIRA)

unread,
Nov 27, 2019, 6:05:03 AM11/27/19
to jenkinsc...@googlegroups.com
Peder Schmedling updated an issue
Change By: Peder Schmedling
This relates to JENKINS-19760 and JENKINS-31209 resolved by [https://github.com/jenkinsci/jenkins/pull/4209] where build description in build history widget is no longer truncated. A regression of this is that for elaborate build descriptions the build history widget becomes unusable.

The change did not sit well with our organization as our build descriptions are quite extensive. We use groovy code to parse log output which results in a big html blob containing details about versions, servers, errors, warns git commit and details, related jira issues etc. This html is then used as build description which results in nice reports when the user views the job details:

!image-2019-11-27-12-00-28-106.png| thumnail thumbnail !


The issue after the change realted to JENKINS-19760 and JENKINS-31209 is that this full html report is also displayed in the build history widget:

!image-2019-11-27-12-01-21-459.png| thumnail thumbnail !


Possible solutions:
- Have truncation length ({{maxDescrLength}}) configurable.
- Possibility to hide build description in build history widget.

peder.schmedling@dsb.no (JIRA)

unread,
Nov 27, 2019, 6:06:06 AM11/27/19
to jenkinsc...@googlegroups.com
Peder Schmedling updated an issue
This relates to JENKINS-19760 and JENKINS-31209 resolved by [https://github.com/jenkinsci/jenkins/pull/4209] where build description in build history widget is no longer truncated. A regression of this is that for elaborate build descriptions the build history widget becomes unusable.

The change did not sit well with our organization as our build descriptions are quite extensive. We use groovy code to parse log output which results in a big html blob containing details about versions, servers, errors, warns git commit and details, related jira issues etc. This html is then used as build description which results in nice reports when the user views the job details:

!image-2019-11-27-12-00-28-106.png|thumbnail!

The issue after the change realted related to JENKINS-19760 and JENKINS-31209 is that this full html report is also displayed in the build history widget which practically makes the widget unusable :

!image-2019-11-27-12-01-21-459.png|thumbnail!

Possible solutions:
- Have truncation length ({{maxDescrLength}}) configurable.
- Possibility to hide build description in build history widget.

dbeck@cloudbees.com (JIRA)

unread,
Nov 27, 2019, 8:48:03 AM11/27/19
to jenkinsc...@googlegroups.com
Daniel Beck updated an issue
Change By: Daniel Beck
Labels: lts-candidate

dbeck@cloudbees.com (JIRA)

unread,
Nov 27, 2019, 8:49:03 AM11/27/19
to jenkinsc...@googlegroups.com
Daniel Beck commented on Improvement JENKINS-60299
 
Re: Make build description in build history widget configurable or possible to hide

Perhaps auto-hide a description if its rendered size would be too big? I.e. do not introduce a new option, but do the right thing based on content?

Is this feasible?

peder.schmedling@dsb.no (JIRA)

unread,
Nov 27, 2019, 9:19:02 AM11/27/19
to jenkinsc...@googlegroups.com

Sounds good to me. I have no idea what the general use case is but for our use case auto hide would suffice

peder.schmedling@dsb.no (JIRA)

unread,
Nov 30, 2019, 5:14:03 PM11/30/19
to jenkinsc...@googlegroups.com

A possible workaround for those interested:

  1. Install Simple theme plugin
  2. Go to "Manage Jenkins" > "Configure System" > "Theme"
  3. Add "Extra CSS" with the following content: 
    .cards_container.zws-inserted {
    display:none;
}

jsoref+jenkins@gmail.com (JIRA)

unread,
Feb 6, 2020, 2:38:03 PM2/6/20
to jenkinsc...@googlegroups.com
Josh Soref updated an issue
 
Change By: Josh Soref
Attachment: image-2020-02-06-14-37-27-125.png

jsoref+jenkins@gmail.com (JIRA)

unread,
Feb 6, 2020, 2:39:02 PM2/6/20
to jenkinsc...@googlegroups.com
Josh Soref commented on Improvement JENKINS-60299
 
Re: Make build description in build history widget configurable or possible to hide

You could use this:

td.build-row-cell > div > .build-link {
 background-color: pink;
 max-height: 3em;
 overflow-y: hidden;
}
td.build-row-cell > div.desc {
 background-color: yellow;
 max-height: 5em;
 overflow-y: hidden;
}

The coloring is included just to make it easy to identify the pieces.

Personally, I think having some default css with some em based limits for both fields would be nice.

I like including stack traces or similar in the second field, and the behavior we got wasn't particularly ideal.

harrygg@java.net (JIRA)

unread,
Feb 11, 2020, 1:12:04 PM2/11/20
to jenkinsc...@googlegroups.com
Harry G. commented on Improvement JENKINS-60299

Thanks a lot! For me at first this didn't work, as our description contains html tables and still breaks out in width.
So addes max-with which then works for me for desktop (probably not perfect for mobile)

td.build-row-cell > div > .build-link {
 max-height: 3em;
 max-width: 320px;
  overflow-y: hidden;
}
td.build-row-cell > div.desc {
 max-height: 5em;
 max-width: 320px;
 overflow-y: hidden;
}

What remains is the high loading time, in my example few minutes on FF and more on Chrome, forever on IE.

 

harrygg@java.net (JIRA)

unread,
Feb 11, 2020, 1:12:07 PM2/11/20
to jenkinsc...@googlegroups.com
Harry G. edited a comment on Improvement JENKINS-60299
Thanks a lot! For me at first this didn't work, as our description contains html tables and still breaks out in width.
So addes I added max-with which then works for me for desktop (probably not perfect for mobile)


{{td.build-row-cell > div > .build-link {}}
{{ max-height: 3em;}}
{{ max-width: 320px;}}
{{  overflow-y: hidden;}}
{{}}}
{{td.build-row-cell > div.desc {}}
{{ max-height: 5em;}}
{{ max-width: 320px;}}
{{ overflow-y: hidden;}}
{{}}}

What remains is the high loading time, in my example few minutes on FF and more on Chrome, forever on IE.

 

o.v.nenashev@gmail.com (JIRA)

unread,
Feb 28, 2020, 3:13:05 AM2/28/20
to jenkinsc...@googlegroups.com
Oleg Nenashev assigned an issue to Oleg Nenashev
 
Change By: Oleg Nenashev
Assignee: Oleg Nenashev
This message was sent by Atlassian Jira (v7.13.12#713012-sha1:6e07c38)
Atlassian logo

o.v.nenashev@gmail.com (JIRA)

unread,
Feb 28, 2020, 3:13:05 AM2/28/20
to jenkinsc...@googlegroups.com
Oleg Nenashev started work on Improvement JENKINS-60299
 
Change By: Oleg Nenashev
Status: Open In Progress

o.v.nenashev@gmail.com (JIRA)

unread,
Feb 28, 2020, 3:13:05 AM2/28/20
to jenkinsc...@googlegroups.com
Change By: Oleg Nenashev
Status: In Progress Review

o.v.nenashev@gmail.com (JIRA)

unread,
Feb 28, 2020, 3:14:05 AM2/28/20
to jenkinsc...@googlegroups.com

dbeck@cloudbees.com (JIRA)

unread,
Mar 11, 2020, 2:51:03 AM3/11/20
to jenkinsc...@googlegroups.com

Oleg Nenashev So is this done for now? If so, this should be resolved and marked as addressed in 2.223, otherwise I expect it won't make it into 2.222.1.

harrygg@java.net (JIRA)

unread,
Mar 11, 2020, 9:53:03 AM3/11/20
to jenkinsc...@googlegroups.com
Harry G. commented on Improvement JENKINS-60299

Confirmed in 2.225 by setting up a test job with 10 runs and huuuge html descriptions:

  • load time is fast again
  • descriptions are truncated
  • build parameters are not overlayed

So this is resolved and can be closed!
We are eagerly waiting for the LTS that brings it to our productive Jenkins.
Thanks a lot Oleg Nenashev for driving it forward!

peder.schmedling@dsb.no (JIRA)

unread,
Mar 11, 2020, 10:00:03 AM3/11/20
to jenkinsc...@googlegroups.com

I can also confirm that the issue is resolved for our use-case in v 2.225.

Thanks

jenkins@markus-schenkel.ch (JIRA)

unread,
Mar 18, 2020, 6:59:02 AM3/18/20
to jenkinsc...@googlegroups.com

Should the new system property "historyWidget.descriptionLimit" also be documented on the page "Features controlled by system properties"?

Also when setting it through script console using the following, I can not currently disable the limit. Is this expected?

System.setProperty("historyWidget.descriptionLimit", "-1") // also tried 0
println SystemProperties.getInteger("historyWidget.descriptionLimit") // value does change to -

 

dbeck@cloudbees.com (JIRA)

unread,
Mar 18, 2020, 7:03:02 AM3/18/20
to jenkinsc...@googlegroups.com

Should the new system property "historyWidget.descriptionLimit" also be documented on the page "Features controlled by system properties"?

See the giant banner on the top of the page.

o.v.nenashev@gmail.com (JIRA)

unread,
Mar 18, 2020, 8:14:03 AM3/18/20
to jenkinsc...@googlegroups.com

> Should the new system property "historyWidget.descriptionLimit" also be documented on the page "Features controlled by system properties"?

Jenkins Wiki is deprecated. I am exploring options to replace the manually generated doc by an automated way to list system properties. See https://jenkins.io/doc/developer/extensions/ for example (autogenerated)

jenkins@markus-schenkel.ch (JIRA)

unread,
Mar 19, 2020, 10:45:05 AM3/19/20
to jenkinsc...@googlegroups.com

Sorry, but I did not read "maintenance issues" as "deprecated". also the mobile version does not show the banner at all.
Also the banner does not appear at all on the mobile version.

Any idea why it can not be changed through the script console using

System.setProperty("historyWidget.descriptionLimit", "-1") // also tried 0
println SystemProperties.getInteger("historyWidget.descriptionLimit") // value does change to -

dbeck@cloudbees.com (JIRA)

unread,
Mar 19, 2020, 12:11:02 PM3/19/20
to jenkinsc...@googlegroups.com

Startup-only system property.

jenkins@markus-schenkel.ch (JIRA)

unread,
Mar 19, 2020, 12:31:03 PM3/19/20
to jenkinsc...@googlegroups.com
Markus Schenkel edited a comment on Improvement JENKINS-60299
Sorry, but I did not read "maintenance issues" as "deprecated". also the mobile version does not show the banner at all.
 Also the banner does not appear at all on the mobile version.

Any idea why it can not be changed through the script console using
{code:java}

System.setProperty("historyWidget.descriptionLimit", "-1") // also tried 0
println SystemProperties.getInteger("historyWidget.descriptionLimit") // value does change to -{code}

o.v.nenashev@gmail.com (JIRA)

unread,
Mar 23, 2020, 11:27:03 AM3/23/20
to jenkinsc...@googlegroups.com

FTR I created https://github.com/jenkins-infra/jenkins.io/pull/2992 to migrate system properties there. Once approved, I will add the newly introduced property there

jglick@cloudbees.com (JIRA)

unread,
Apr 15, 2020, 2:04:05 PM4/15/20
to jenkinsc...@googlegroups.com

Rather than messing around with workarounds, you should stop abusing the build description for this purpose. It is designed for a small one-line description, like a short phrase. If you want to display some big blob of text on the build main page, find or write a plugin with a publisher which lets you create an action with a main view.

dbeck@cloudbees.com (JIRA)

unread,
Apr 15, 2020, 2:39:03 PM4/15/20
to jenkinsc...@googlegroups.com

Jesse Glick

small one-line description

It's a 1) multiline text box that takes 2) unlimited length text and 3) supports markup formatting. NONE of that indicates that its use should be as you describe.

dbeck@cloudbees.com (JIRA)

unread,
Apr 15, 2020, 2:40:02 PM4/15/20
to jenkinsc...@googlegroups.com
Daniel Beck edited a comment on Improvement JENKINS-60299
[~jglick]
{quote}small one-line description
{quote}
It's a 1) multiline text box that takes 2) unlimited length text and 3) that has been  truncated for display in the sidepanel forever and 4) supports markup formatting. NONE of that indicates that its use should be as you describe.

harrygg@java.net (JIRA)

unread,
May 5, 2020, 10:46:02 AM5/5/20
to jenkinsc...@googlegroups.com
Harry G. commented on Improvement JENKINS-60299

Jesse Glick and no matter if it is seen as reasonable use - it's just a pure regression if jobs working ever since suddenly need minutes or hours of loading time and screens are broken...

harrygg@java.net (JIRA)

unread,
May 5, 2020, 10:47:03 AM5/5/20
to jenkinsc...@googlegroups.com
Harry G. commented on Improvement JENKINS-60299

Oleg Nenashev any plans for getting this into LTS? We are still suffering and it's been a while since 2.223... Thanks a lot!
Reply all
Reply to author
Forward
0 new messages