Add updates count badge to Updates sidebar item #7084

janfaracik · 2022-09-08T20:32:59Z

Adds back the updates count badge introduced and removed in #6783, this time by adding an attribute to the task.jelly component so that any view/plugin can use it.

Proposed changelog entries

Add updates count badge to Updates sidebar item.

Proposed upgrade guidelines

N/A

Submitter checklist

(If applicable) 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) and are in the imperative mood. 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
New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadoc, 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 directives (see documentation on jenkins.io).
For dependency updates: links to external changelogs and, if possible, full diffs

Desired reviewers

@jenkinsci/sig-ux

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 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, 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 must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).

timja

lgtm, tested locally

NotMyFault

Looks nice :)

(feedback is non-blocking)

core/src/main/resources/lib/layout/task.jelly

Co-authored-by: Alexander Brandes <brandes.alexander@web.de>

core/src/main/resources/lib/layout/task.jelly

Co-authored-by: Daniel Beck <1831569+daniel-beck@users.noreply.github.com>

daniel-beck

Looks reasonable. Implementation is fine.

There should be usage guidelines.

timja · 2022-09-09T10:48:47Z

There should be usage guidelines.

@janfaracik is that something you're able to add to design library before we ship this?

missed something

janfaracik · 2022-09-09T10:49:36Z

There should be usage guidelines.

@janfaracik is that something you're able to add to design library before we ship this?

Will do, am I good to add it to the existing 'Layouts' PR?

daniel-beck · 2022-09-09T10:51:15Z

I think there should there be support for badges in context menus. For a generalized feature (e.g. imagine badges with open issues in various warnings-ng contributed sidepanel tasks) it probably makes sense to support that. Another use case of an improved task API for the context menu would be Manage Jenkins and entries like "Manage Old Data" or "In-process Script Approval" that could show a badge.

timja · 2022-09-09T10:55:29Z

Will do, am I good to add it to the existing 'Layouts' PR?

Yes 👍

janfaracik · 2022-09-09T12:50:51Z

Will do, am I good to add it to the existing 'Layouts' PR?

Yes 👍

Updated that PR with some examples of when to use badges:

timja · 2022-09-09T13:00:16Z

Do you plan to address Daniel's comment on badges in context menu's in this PR?

janfaracik · 2022-09-10T14:45:59Z

Do you plan to address Daniel's comment on badges in context menu's in this PR?

I'd favour doing them separately to this PR (just to get this in as I think its a nice-to-have), happy to do it though in this if you prefer @daniel-beck?

daniel-beck · 2022-09-10T20:44:29Z

I'd prefer that this is done at the same time, to have parity between sidepanel and menus. (Unless there's a UX reason that menus should not have these badges, now or later, of course.)

timja · 2022-10-20T08:02:13Z

@janfaracik do you plan to take a look at the context menu changes?

janfaracik · 2022-10-23T12:11:54Z

@janfaracik do you plan to take a look at the context menu changes?

I will do for sure, just a little swamped at the moment.

github-actions · 2023-03-25T09:51:22Z

Please take a moment and address the merge conflicts of your pull request. Thanks!

Changes addressed

NotMyFault

The number in the plugin manager could use the same color as the badge in the manage view:

But I consider this non-blocking feedback, thanks for your work!

daniel-beck

The tooltip isn't just in a "plain" HTML environment, but in an HTML attribute.

A tooltip of " onmouseenter=alert(1) " causes XSS.

As a general recommendation, stop concatenating strings to create HTML entirely.

obsolete

janfaracik · 2023-04-13T12:24:34Z

Is this PR good for merge notice now @timja?

timja · 2023-04-13T15:05:22Z

/label ready-for-merge

This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

mawinter69 · 2023-04-24T23:34:56Z

core/src/main/resources/lib/layout/task.jelly

@@ -75,6 +75,9 @@ THE SOFTWARE.
      Generally used with post="true".
      (onclick supersedes this except in the context menu.)
    </st:attribute>
+    <st:attribute name="badge" since="TODO">
+      If set, displays the value as a small badge on the right side of the sidepanel item.


This needs a better description. At the moment most people will assume this is just a simple text you can pass in but what is actually is required is a jenkins.management.Badge object.

…em (jenkinsci#7084)" The "Manage Jenkins" / "System" drop down menu includes the extra text "undefined" at the end of each entry. This removes that change and removes the updates count badge from the updates sidebar. This reverts commit 291f5ed.

[JENKINS-71345] Revert "Add updates count badge to Updates sidebar item (#7084)" The "Manage Jenkins" / "System" drop down menu includes the extra text "undefined" at the end of each entry. This removes that change and removes the updates count badge from the updates sidebar. This reverts commit 291f5ed.

Init

6dbdcc2

timja 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 needs-security-review Awaiting review by a security team member labels Sep 8, 2022

timja requested a review from a team September 8, 2022 21:18

timja approved these changes Sep 8, 2022

View reviewed changes

NotMyFault approved these changes Sep 8, 2022

View reviewed changes

core/src/main/resources/lib/layout/task.jelly Outdated Show resolved Hide resolved

Update core/src/main/resources/lib/layout/task.jelly

82df255

Co-authored-by: Alexander Brandes <brandes.alexander@web.de>

daniel-beck mentioned this pull request Sep 9, 2022

Add sidebar to plugin manager, increase search bar size #6783

Merged

12 tasks

daniel-beck reviewed Sep 9, 2022

View reviewed changes

core/src/main/resources/lib/layout/task.jelly Outdated Show resolved Hide resolved

Remove duplicated class

7521983

daniel-beck reviewed Sep 9, 2022

View reviewed changes

core/src/main/resources/lib/layout/task.jelly Outdated Show resolved Hide resolved

daniel-beck added security-approved @jenkinsci/core-security-review reviewed this PR for security issues and removed needs-security-review Awaiting review by a security team member labels Sep 9, 2022

Update core/src/main/resources/lib/layout/task.jelly

c807da3

Co-authored-by: Daniel Beck <1831569+daniel-beck@users.noreply.github.com>

daniel-beck previously approved these changes Sep 9, 2022

View reviewed changes

janfaracik added 3 commits October 23, 2022 20:47

Merge branch 'master' into add-updates-badge

891ee2a

Add support for badges in menus + manage jenkins page

7054195

Update index.jelly

f85289f

Merge branch 'master' into add-updates-badge

d6f4f5e

github-actions bot removed the unresolved-merge-conflict There is a merge conflict with the target branch. label Mar 25, 2023

NotMyFault approved these changes Mar 25, 2023

View reviewed changes

daniel-beck previously requested changes Mar 28, 2023

View reviewed changes

janfaracik added 5 commits April 9, 2023 15:59

Merge branch 'master' into add-updates-badge

95b4f10

Use xmlEscape for escaping attributes

1bf1bd1

Support nulls

a69e28a

Update breadcrumbs.js

a3e4dde

Update breadcrumbs.js

b7bf23f

daniel-beck added security-approved @jenkinsci/core-security-review reviewed this PR for security issues and removed needs-security-review Awaiting review by a security team member labels Apr 13, 2023

Merge branch 'master' into add-updates-badge

9ce1b64

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 Apr 13, 2023

NotMyFault merged commit 291f5ed into jenkinsci:master Apr 16, 2023

mawinter69 reviewed Apr 24, 2023

View reviewed changes

janfaracik deleted the add-updates-badge branch May 5, 2023 12:15

MarkEWaite mentioned this pull request May 25, 2023

[JENKINS-71345] Remove 'undefined' from system dropdown menu #8052

Merged

14 tasks

This was referenced Jul 12, 2023

allow string for badge attribute of l:task #8260

Closed

Add guidance on page layouts jenkinsci/design-library-plugin#90

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add updates count badge to Updates sidebar item #7084

Add updates count badge to Updates sidebar item #7084

janfaracik commented Sep 8, 2022 •

edited by MarkEWaite

Loading

timja left a comment •

edited

Loading

NotMyFault left a comment

daniel-beck left a comment

timja commented Sep 9, 2022

janfaracik commented Sep 9, 2022

daniel-beck commented Sep 9, 2022 •

edited

Loading

timja commented Sep 9, 2022

janfaracik commented Sep 9, 2022

timja commented Sep 9, 2022

janfaracik commented Sep 10, 2022

daniel-beck commented Sep 10, 2022

timja commented Oct 20, 2022

janfaracik commented Oct 23, 2022

github-actions bot commented Mar 25, 2023

NotMyFault left a comment

daniel-beck left a comment •

edited

Loading

janfaracik commented Apr 13, 2023

timja commented Apr 13, 2023

mawinter69 Apr 24, 2023

Add updates count badge to Updates sidebar item #7084

Add updates count badge to Updates sidebar item #7084

Conversation

janfaracik commented Sep 8, 2022 • edited by MarkEWaite Loading

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

timja left a comment • edited Loading

Choose a reason for hiding this comment

NotMyFault left a comment

Choose a reason for hiding this comment

daniel-beck left a comment

Choose a reason for hiding this comment

timja commented Sep 9, 2022

janfaracik commented Sep 9, 2022

daniel-beck commented Sep 9, 2022 • edited Loading

timja commented Sep 9, 2022

janfaracik commented Sep 9, 2022

timja commented Sep 9, 2022

janfaracik commented Sep 10, 2022

daniel-beck commented Sep 10, 2022

timja commented Oct 20, 2022

janfaracik commented Oct 23, 2022

github-actions bot commented Mar 25, 2023

NotMyFault left a comment

Choose a reason for hiding this comment

daniel-beck left a comment • edited Loading

Choose a reason for hiding this comment

janfaracik commented Apr 13, 2023

timja commented Apr 13, 2023

mawinter69 Apr 24, 2023

Choose a reason for hiding this comment

janfaracik commented Sep 8, 2022 •

edited by MarkEWaite

Loading

timja left a comment •

edited

Loading

daniel-beck commented Sep 9, 2022 •

edited

Loading

daniel-beck left a comment •

edited

Loading