Skip to content

Add help for "remove last build" in Manage Jenkins#26153

Merged
MarkEWaite merged 6 commits intojenkinsci:masterfrom
AmoghParmar:add-help-remove-last-build-clean
Jan 26, 2026
Merged

Add help for "remove last build" in Manage Jenkins#26153
MarkEWaite merged 6 commits intojenkinsci:masterfrom
AmoghParmar:add-help-remove-last-build-clean

Conversation

@AmoghParmar
Copy link
Contributor

@AmoghParmar AmoghParmar commented Jan 21, 2026

Fixes #16688

This pull request adds missing online help documentation for the
“Remove last build” option of the LogRotator build discarder.

The help text explains the behavior, provides an example,
and references Pipeline usage.

Testing done

  • Built Jenkins locally from source
  • Verified the new help icon appears for the “Remove last build” option in
    Manage Jenkins → Configure System → Build Discarder → Advanced
  • Clicked the help icon and confirmed the help text renders correctly

Screenshots (UI changes only)

Before

image No online help was available for the “Remove last build” option.

After

image image A help icon is displayed next to the “Remove last build” option, showing detailed documentation when clicked.

Proposed changelog entries

  • Add online help for the “Remove last build” build discarder option.

Proposed changelog category

/label rfe,web-ui

Proposed upgrade guidelines

N/A

Submitter checklist

  • The issue, if it exists, is well-described.
  • The changelog entries and upgrade guidelines are appropriate.
  • There is automated testing or an explanation as to why this change has no tests.
  • UI changes do not introduce regressions with Content Security Policy.

Maintainer checklist

  • At least two approvals
  • No unresolved conversations
  • Changelog entries look correct
  • Proper labels set

Desired reviewers

@jenkinsci/core-pr-reviewers

@comment-ops-bot comment-ops-bot bot added rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted web-ui The PR includes WebUI changes which may need special expertise labels Jan 21, 2026
@MarkEWaite MarkEWaite changed the title Add help remove last build clean Add help for "remove last build" in Manage Jenkins Jan 23, 2026
Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please restore the pull request template, including the submitter checklist and the maintainer checklist and the changelog description

Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additional comment on the Pipeline example

@AmoghParmar
Copy link
Contributor Author

@MarkEWaite Thanks for the review and the helpful guidance.

I have now:

  • Restored the full pull request template, including the submitter and maintainer checklists

  • Added the changelog entry and category

  • Updated the Pipeline example to match what the declarative directive generator suggests

Please let me know if anything else should be adjusted.

My suggestion used the code tag, but should have used the pre tag
@MarkEWaite
Copy link
Contributor

@MarkEWaite Thanks for the review and the helpful guidance.

I have now:

  • Restored the full pull request template, including the submitter and maintainer checklists
  • Added the changelog entry and category
  • Updated the Pipeline example to match what the declarative directive generator suggests

Please let me know if anything else should be adjusted.

You are sabotaging yourself by not doing local checks and by not reviewing the results of the automated checks performed on the pull request. Those automated checks fail the build due to a formatting error. The contributing guide tells you how to correct the formatting error.

  • Build the change locally by following the instructions in the contributing guide.
    It doesn't appear that you read the contributing guide section that discusses how to handle code formatting and didn't apply the formatting fixes
  • Use the pull request template and provide all the information it requests.
    You didn't include all the items when you re-added the maintainer checklist and you didn't actually address the question in the submitter checklist that asks for an explanation why automated tests are not included. I agree that this change does not need automated tests, but you didn't address the checklist item in your pull request. Please state that you intentionally did not add an automated test.

While reviewing your change locally, I discovered that my original change proposal was wrong. I used the <code> HTML tag to surround the example Pipeline script. That was incorrect. The Jenkins online help surrounds examples with the <pre> HTML tag. While working with yarn lint:fix, I found that the formatting needed to be adjusted. I made those two corrections and pushed the change.

@MarkEWaite
Copy link
Contributor

Now that you've developed experience adding online help to Jenkins, it would be nice if you could submit another pull request (or two) that add online help to the other parts of the build discarder. Don't do that in this pull request. It is ready to merge as far as I can tell.

@MarkEWaite MarkEWaite self-assigned this Jan 25, 2026
Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is now ready for merge. We will merge it after approximately 24 hours if there is no negative feedback.

/label ready-for-merge

@comment-ops-bot comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Jan 25, 2026
@MarkEWaite MarkEWaite merged commit 04a0869 into jenkinsci:master Jan 26, 2026
18 checks passed
meetgoti07 pushed a commit to meetgoti07/jenkins that referenced this pull request Jan 29, 2026
* Add online help for removeLastBuild option

* Format help-removeLastBuild.html with Prettier

* Update core/src/main/resources/hudson/tasks/LogRotator/help-removeLastBuild.html

Co-authored-by: Mark Waite <[email protected]>

* Fix formatting and use correct HTML tag

My suggestion used the code tag, but should have used the pre tag

---------

Co-authored-by: Mark Waite <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted web-ui The PR includes WebUI changes which may need special expertise

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[JENKINS-75463] core build discarder "Remove last build" has no online help

3 participants