[JENKINS-61004, JENKINS-60299] - Reintroduce Build History description truncation by default, allow managing/disabling the limit via a system property #4529

oleg-nenashev · 2020-02-28T08:11:40Z

This is a backportable version of #4489 which does not introduce the new summary field. See JENKINS-61004 and JENKINS-60299.

Proposed changelog entries

bug: Reintroduce Build History description truncation by default. Allow managing/disabling the limit via the historyWidget.descriptionLimit system property (negative value - remove the limit, 0 - force empty descriptions)
...

Proposed upgrade guidelines

N/A

Submitter checklist

JIRA issue is well described
Changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developer, depending on the change). Examples
- Fill-in the Proposed changelog entries section only if there are breaking changes or other changes which may require extra steps from users during the upgrade
Appropriate autotests or explanation to why this change has no tests
For dependency updates: links to external changelogs and, if possible, full diffs

Desired reviewers

@mention

Maintainer checklist

Before the changes are marked as ready-for-merge:

There are at least 2 approvals for the pull request and no outstanding requests for change
Conversations in the pull request are over OR it is explicit that a reviewer does not block the change
Changelog entries in the PR title and/or Proposed changelog entries are correct
Proper changelog labels are set so that the changelog can be generated automatically
If the change needs additional upgrade steps from users, upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the PR title. (example)
If it would make sense to backport the change to LTS, a JIRA issue should exist and be labeled as lts-candidate

… default, allow managing/disabling the limit via a system property

timja

one nit, but approving

timja · 2020-02-28T08:24:00Z

core/src/main/java/hudson/model/Run.java

            return description;
        }
+        if (TRUNCATED_DESCRIPTION_LIMIT == 0) { // Someone wants to suppress descriptions, why not?


personally I would make 0 disable truncation as 0 often means unlimited, why introduce a feature to disable descriptions? has anyone asked for it?

"Possible to hide" in https://issues.jenkins-ci.org/browse/JENKINS-60299

That was 2 possible solutions, didn't suggest implementing both 😉

Hi, just wanted to chime in. I'm the one who created JENKINS-60299. For our use-case a possibility to disable the build description in the build history widget would be really nice. Note though that we very much need the build description for each build, just not in the widget itself.
Off course, I'm just one user so I understand if our specific need cannot be taken into account and implemented as a feature for all users :-)

🤷‍♂ fine with me then.

Seems like a reasonable option for people using non-HTML markup formatting, which is horrifically broken by the server-side, pre-transformation truncation.

daniel-beck

Reviewed but not tested. Minor suggestions, would consider them nice but non-blocking.

Let's be explicit that this won't be the final state but rather a stop gap, and 🚢 🇮🇹

core/src/main/java/hudson/model/Run.java

daniel-beck · 2020-02-28T16:28:02Z

core/src/main/java/hudson/model/Run.java

     * @return The length-limited description.
-     * @deprecated truncated description uses arbitrary and unconfigurable limit of 100 symbols
+     * @deprecated truncated description based on the {@link #TRUNCATED_DESCRIPTION_LIMIT} setting.


The deprecation doesn't really make sense anymore? At least for a while?

I do not want to revert it for now, will probably act on that in a follow-up PR

daniel-beck · 2020-02-28T16:29:22Z

core/src/main/java/hudson/model/Run.java

     */
    @Deprecated
-    public @Nonnull String getTruncatedDescription() {


How was this ever @Nonnull? 😕

core/src/main/java/hudson/model/Run.java

Co-Authored-By: Daniel Beck <[email protected]>

oleg-nenashev · 2020-02-28T16:41:38Z

Taking the approvals, I plan to merge it tomorrow if no negative feedback

oleg-nenashev · 2020-03-01T06:23:33Z

ATH is stuck due to the infra issues. I will ignore it and get it merged

harry-g · 2020-03-11T13:53:13Z

Tested OK in 2.225 by setting up a test job with 10 runs and huuuge html descriptions (see JENKINS-60299).
Thanks a lot @oleg-nenashev for driving it forward!

[JENKINS-61004] - Reintroduce Build History description truncation by…

027cae3

… default, allow managing/disabling the limit via a system property

oleg-nenashev added the bug For changelog: Minor bug. Will be listed after features label Feb 28, 2020

oleg-nenashev requested review from slonopotamus, daniel-beck, timja and res0nance February 28, 2020 08:11

oleg-nenashev mentioned this pull request Feb 28, 2020

Introduce a new summary description field for jobs #4489

Closed

10 tasks

timja approved these changes Feb 28, 2020

View reviewed changes

slonopotamus approved these changes Feb 28, 2020

View reviewed changes

oleg-nenashev requested a review from a team February 28, 2020 13:17

daniel-beck approved these changes Feb 28, 2020

View reviewed changes

Apply suggestions from code review by @daniel-beck

fa99385

Co-Authored-By: Daniel Beck <[email protected]>

oleg-nenashev added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Feb 28, 2020

daniel-beck approved these changes Feb 28, 2020

View reviewed changes

oleg-nenashev merged commit e4843ae into jenkinsci:master Mar 1, 2020

oleg-nenashev mentioned this pull request Mar 3, 2020

[JENKINS-61004] - Default limits for buildHistoryPage row heights #4477

Closed

10 tasks

daniel-beck mentioned this pull request Mar 16, 2020

Update at-since up to and including 2.226 #4587

Merged

10 tasks

jachiev8a mentioned this pull request Aug 24, 2020

update system-properties.adoc documentation for historyWidget.descriptionLimit jenkins-infra/jenkins.io#3652

Merged

PhilippHomann mentioned this pull request Oct 8, 2020

Don't render description pane when historyWidget.descriptionLimit is 0 #4978

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JENKINS-61004, JENKINS-60299] - Reintroduce Build History description truncation by default, allow managing/disabling the limit via a system property #4529

[JENKINS-61004, JENKINS-60299] - Reintroduce Build History description truncation by default, allow managing/disabling the limit via a system property #4529

oleg-nenashev commented Feb 28, 2020 •

edited

Loading

timja left a comment

timja Feb 28, 2020

oleg-nenashev Feb 28, 2020

timja Feb 28, 2020

Laffs2k5 Feb 28, 2020

timja Feb 28, 2020

daniel-beck Feb 28, 2020

daniel-beck left a comment

daniel-beck Feb 28, 2020

oleg-nenashev Feb 28, 2020

daniel-beck Feb 28, 2020

oleg-nenashev Feb 28, 2020

oleg-nenashev commented Feb 28, 2020

oleg-nenashev commented Mar 1, 2020

harry-g commented Mar 11, 2020 •

edited

Loading

[JENKINS-61004, JENKINS-60299] - Reintroduce Build History description truncation by default, allow managing/disabling the limit via a system property #4529

[JENKINS-61004, JENKINS-60299] - Reintroduce Build History description truncation by default, allow managing/disabling the limit via a system property #4529

Conversation

oleg-nenashev commented Feb 28, 2020 • edited Loading

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

timja left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daniel-beck left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oleg-nenashev commented Feb 28, 2020

oleg-nenashev commented Mar 1, 2020

harry-g commented Mar 11, 2020 • edited Loading

oleg-nenashev commented Feb 28, 2020 •

edited

Loading

harry-g commented Mar 11, 2020 •

edited

Loading