Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

allow string for badge attribute of l:task #8260

Closed
wants to merge 1 commit into from

Conversation

mawinter69
Copy link
Contributor

@mawinter69 mawinter69 commented Jul 12, 2023

The documentation can be interpreted that the badge attribute accepts a String as argument. But in reality it requires an instance of jenkins.management.Badge

The effect can be seen on the Design Library
https://weekly.ci.jenkins.io/design-library/Layouts/twoColumn
Where a String is passed but is not shown.

This change allows either a Badge object or something else which is then just printed.

Testing done

I tested this by modifying the sidepanel of the ComputerSet page
<l:task href="${h.getNearestAncestorUrl(request,it)}/" icon="symbol-computer"
title="${%Nodes}" badge="${it._all.size()}"/>
The page then properly show me the number of agents (without having a tooltip)
On the plugins page the number of updates is still shown with a tooltip.

Before:
image

After:
image

image

Proposed changelog entries

  • Allow string for badge attribute of <l:task ...>.

Proposed upgrade guidelines

N/A

Submitter checklist

  • The Jira issue, if it exists, is well-described.
  • The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
  • There is automated testing or an explanation as to why this change has no tests.
  • New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
  • New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
  • New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
  • For dependency updates, there are links to external changelogs and, if possible, full differentials.
  • For new APIs and extension points, there is a link to at least one consumer.

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

Maintainer checklist

  • There are at least two (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 is not blocking the change.
  • Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
  • Proper changelog labels are set so that the changelog can be generated automatically.
  • If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
  • If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).

The documentation states that the badge attribute accepts a value as
argument. But in reality it requires an instance of
jenkins.management.Badge

The effect can be seen on the Design Library
https://weekly.ci.jenkins.io/design-library/Layouts/twoColumn
Where a String is passed but not shown.

This change allows to have both either a Badge object or something else
which is then just printed.
@daniel-beck
Copy link
Member

daniel-beck commented Jul 12, 2023

What's the use case for this? AFAIUI, badges in #7084 started as int but became Badge when #6995 was merged in in 70966cf, docs might just not have been adapted.

@mawinter69
Copy link
Contributor Author

mawinter69 commented Jul 12, 2023

OK so far it seems nobody uses the badge attribute except for the pluginmanager. So maybe updating the docs might be enough and we should fix the design library

@daniel-beck
Copy link
Member

CC @janfaracik who wrote jenkinsci/design-library-plugin#90.

@MarkEWaite MarkEWaite added developer Changes which impact plugin developers rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted labels Aug 5, 2023
@timja timja added the proposed-for-close There is no consensus about feasibility of this PR, and maintainers do not see a way forward for it label Aug 5, 2023
@NotMyFault NotMyFault requested a review from janfaracik August 6, 2023 14:30
@mawinter69
Copy link
Contributor Author

Close in favor of #8469

@mawinter69 mawinter69 closed this Sep 6, 2023
@mawinter69 mawinter69 deleted the fix-task-badge branch January 31, 2025 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer Changes which impact plugin developers proposed-for-close There is no consensus about feasibility of this PR, and maintainers do not see a way forward for it rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants