Use symbols for build status #8705

janfaracik · 2023-11-20T16:06:30Z

Rather late followup to #7208 in which weather icons were replaced with symbols. This PR does the same for build status icons and also updates the appearance of some of them (do give feedback on this!).

The current approach to build status icons is a little unwieldy and can break in some scenarios (see below images). Using symbols is consistent with near enough every other icon in core Jenkins and keeps things simple to update in the future.

Before

After

Before (in Safari)

After

Testing done

Icons appear as expected on the dashboard
Icons appear as expected in build history (page and widget format)
Icons appear as expected in build time trend (fixes a UI issue in Safari too)

Proposed changelog entries

Refine build status icons

Proposed upgrade guidelines

N/A

Submitter checklist

Give feedback

The Jira issue, if it exists, is well-described.

The Jira issue, if it exists, is well-described.
Options
Successfully updated the issue's project

There was an error updating the issue's project
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](https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/weekly.yml)). Fill in the **Proposed upgrade guidelines** section only if there are breaking changes or changes that may require extra steps from users during upgrade.

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.
Options
Successfully updated the issue's project

There was an error updating the issue's project
There is automated testing or an explanation as to why this change has no tests.

There is automated testing or an explanation as to why this change has no tests.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New public classes, fields, and methods are annotated with `@Restricted` or have `@since TODO` Javadocs, as appropriate.

New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New deprecations are annotated with `@Deprecated(since = "TODO")` or `@Deprecated(forRemoval = true, since = "TODO")`, if applicable.

New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
Options
Successfully updated the issue's project

There was an error updating the issue's project
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](https://www.jenkins.io/doc/developer/security/csp/)).

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).
Options
Successfully updated the issue's project

There was an error updating the issue's project
For dependency updates, there are links to external changelogs and, if possible, full differentials.

For dependency updates, there are links to external changelogs and, if possible, full differentials.
Options
Successfully updated the issue's project

There was an error updating the issue's project
For new APIs and extension points, there is a link to at least one consumer.

For new APIs and extension points, there is a link to at least one consumer.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Options

Desired reviewers

@jenkinsci/sig-ux

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

Maintainer checklist

Give feedback

There are at least two (2) approvals for the pull request and no outstanding requests for change.

There are at least two (2) approvals for the pull request and no outstanding requests for change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.

Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Changelog entries in the pull request title and/or **Proposed changelog entries** are accurate, human-readable, and in the imperative mood.

Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Proper changelog labels are set so that the changelog can be generated automatically.

Proper changelog labels are set so that the changelog can be generated automatically.
Options
Successfully updated the issue's project

There was an error updating the issue's project
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](https://github.com/jenkinsci/jenkins/pull/4387)).

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).
Options
Successfully updated the issue's project

There was an error updating the issue's project
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](https://issues.jenkins.io/issues/?filter=12146)).

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).
Options
Successfully updated the issue's project

There was an error updating the issue's project
Options

core/src/main/resources/hudson/model/Job/buildTimeTrend.jelly

core/src/main/resources/lib/hudson/buildListTable.jelly

timja · 2023-11-24T11:14:03Z

The alignment looks a little off in the build history?

Before:

After:

Apart from that looks better to me

janfaracik · 2023-11-24T12:38:13Z

The alignment looks a little off in the build history?

...

Apart from that looks better to me

Not seeing that on my end?

master

use-symbols-for-build-status

timja · 2023-11-24T13:36:56Z

I see it in your screenshot to, maybe not required to fix it's just a bit higher than before.

janfaracik · 2023-11-24T17:53:33Z

I see it in your screenshot to, maybe not required to fix it's just a bit higher than before.

Ah sorry I misunderstood - the icon position is fixed now.

timja

LGTM

NotMyFault

Looks great!

timja · 2023-11-25T20:16:53Z

/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

I have to object. There are still several places where the old things are used. I even found a place where an old blue ball is used.
E.g. create a freestyle job that triggers another freestyle job. This lead to this:

Maybe that old blue ball is coming from https://plugins.jenkins.io/parameterized-trigger/

Places with old implementation:
lib/hudson/buildLink.jelly#55
hudon/model/AbstractBuild/index.jelly#79,#89
hudson/model/Run/statusIcon.jelly#34 (not sure if this is anywhere used
lib/hudson/jobLink.jelly#34

mawinter69 · 2023-11-25T20:58:38Z

Seems the blue ball was recently fixed: jenkinsci/parameterized-trigger-plugin#357

janfaracik · 2023-11-26T13:30:10Z

lib/hudson/buildLink.jelly#55
hudson/model/AbstractBuild/index.jelly#79,#89
hudson/model/Run/statusIcon.jelly#34
lib/hudson/jobLink.jelly#34

Updated those - thanks for finding.

timja · 2023-11-26T21:25:12Z

/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!

MarkEWaite · 2023-11-29T04:45:32Z

@janfaracik thanks very much for the improvement in the build status display! I like it very much.

It appears that the improvement has exposed two unit tests in the JUnit plugin that were dependent on the previous layout. Would you be willing to look at those two tests to adapt them so that they will pass on both Jenkins 2.433 (before the change) and Jenkins 2.434 (after the change)?

Detected in plugin bill of materials pull request:

Update dependency org.jenkins-ci.main:jenkins-war to v2.434 bom#2704

Raised as a JUnit plugin issue in:

AggregatedTestResultPublisherTest fails with Jenkins 2.434 junit-plugin#588

If you're not able to investigate it, please let me know and I'll see if I can find someone else to help.

jenkinsci/junit-plugin#588 is the issue report for the JUnit plugin tests that depend on the icon based build status display. From jenkinsci/jenkins#8705 the Jenkins core pull request that switched from using icon based build status to symbol based build status. That change also fixes a layout issue in the Safari web browser.

NotMyFault · 2023-12-05T14:08:50Z

core/src/main/resources/hudson/model/Job/buildTimeTrend_resources.js

-function generateSVGIcon(iconName, iconSizeClass) {
-  const imagesURL = document.head.getAttribute("data-imagesurl");
-
-  const isInProgress = iconName.endsWith("anime");
-  let buildStatus = "never-built";
-  switch (iconName) {
-    case "red":
-    case "red-anime":
-      buildStatus = "last-failed";
-      break;
-    case "yellow":
-    case "yellow-anime":
-      buildStatus = "last-unstable";
-      break;
-    case "blue":
-    case "blue-anime":
-      buildStatus = "last-successful";
-      break;
-    case "grey":
-    case "grey-anime":
-    case "disabled":
-    case "disabled-anime":
-      buildStatus = "last-disabled";
-      break;
-    case "aborted":
-    case "aborted-anime":
-      buildStatus = "last-aborted";
-      break;
-    case "nobuilt":
-    case "nobuilt-anime":
-      buildStatus = "never-built";
-      break;
-  }


Caused JENKINS-72407

The problem is not here but in StatusColumn -> column.jelly

mawinter69 · 2023-12-05T21:11:24Z

core/src/main/resources/hudson/model/Job/buildTimeTrend_resources.js

-  }
+function generateSVGIcon(iconName) {
+  const icons = document.querySelector("#jenkins-build-status-icons");
+  iconName = iconName.replace("-anime", "");


any reason why the anime svgs are excluded? Before they were animated when the build was running

https://github.com/jenkinsci/junit-plugin/releases/tag/1252.vfc2e5efa_294f is the JUnit plugin release that fixes the test. Special thanks to Tim Jacomb for fixing the test in jenkinsci/junit-plugin#591 jenkinsci/junit-plugin#588 is the issue report for the JUnit plugin tests that depend on the icon based build status display. jenkinsci/jenkins#8705 is the Jenkins core pull request that switched from using icon based build status to symbol based build status. That change also fixes a layout issue in the Safari web browser. This reverts commit cb2376e. Author: Mark Waite <mark.earl.waite@gmail.com> Date: Tue Nov 28 22:00:27 2023 -0700

…c2e5efa_294f in /bom-weekly (#2755) * Bump org.jenkins-ci.plugins:junit in /bom-weekly Bumps [org.jenkins-ci.plugins:junit](https://github.com/jenkinsci/junit-plugin) from 1240.vf9529b_881428 to 1252.vfc2e5efa_294f. - [Release notes](https://github.com/jenkinsci/junit-plugin/releases) - [Commits](https://github.com/jenkinsci/junit-plugin/commits) --- updated-dependencies: - dependency-name: org.jenkins-ci.plugins:junit dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> * Revert "Exclude AggregatedTestResultPublisherTest" https://github.com/jenkinsci/junit-plugin/releases/tag/1252.vfc2e5efa_294f is the JUnit plugin release that fixes the test. Special thanks to Tim Jacomb for fixing the test in jenkinsci/junit-plugin#591 jenkinsci/junit-plugin#588 is the issue report for the JUnit plugin tests that depend on the icon based build status display. jenkinsci/jenkins#8705 is the Jenkins core pull request that switched from using icon based build status to symbol based build status. That change also fixes a layout issue in the Safari web browser. This reverts commit cb2376e. Author: Mark Waite <mark.earl.waite@gmail.com> Date: Tue Nov 28 22:00:27 2023 -0700 --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Mark Waite <mark.earl.waite@gmail.com>

uhafner · 2023-12-23T16:22:59Z

core/src/main/resources/lib/hudson/buildLink.jelly

@@ -52,7 +52,7 @@ THE SOFTWARE.
        </j:when>
        <j:otherwise>
          <a href="${attrs.href ?: rootURL+'/'+r.url}" class="model-link">
-          <l:icon alt="${r.iconColor.description}" class="${r.buildStatusIconClassName} icon-sm" style="margin-left: 0; position: relative; top: -0.1rem;"/><span class="jenkins-icon-adjacent">${jobName_}#<!-- -->${number}</span></a>
+          <l:icon alt="${r.iconColor.description}" src="symbol-status-${r.iconColor.iconName}" class="icon-sm" style="margin-left: 0; position: relative; top: -0.1rem;"/><span class="jenkins-icon-adjacent">${jobName_}#<!-- -->${number}</span></a>


This breaks the build link again (3rd time in the last past months) that is shown in the warnings and coverage links. Maybe we should provide a UI tests for this feature.

uhafner · 2024-01-04T15:22:45Z

FTR: I filed https://issues.jenkins.io/browse/JENKINS-72491

daniel-beck · 2024-02-14T12:30:11Z

Caused JENKINS-72711

daniel-beck · 2024-03-11T10:28:45Z

Caused JENKINS-72845.

Init

5f76f38

mawinter69 suggested changes Nov 20, 2023

View reviewed changes

core/src/main/resources/hudson/model/Job/buildTimeTrend.jelly Outdated Show resolved Hide resolved

core/src/main/resources/lib/hudson/buildListTable.jelly Outdated Show resolved Hide resolved

yaroslavafenkin added the security-approved @jenkinsci/core-security-review reviewed this PR for security issues label Nov 21, 2023

janfaracik added 2 commits November 24, 2023 09:58

Rename ID

aea4d97

Merge branch 'master' into use-symbols-for-build-status-new

18a8407

Fix icon position

c6f5db0

timja approved these changes Nov 24, 2023

View reviewed changes

timja added web-ui The PR includes WebUI changes which may need special expertise rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted labels Nov 24, 2023

timja requested review from mawinter69 and a team November 24, 2023 22:15

janfaracik and others added 2 commits November 25, 2023 09:15

Fix app bar build status icon being incorrect

982bc48

Merge branch 'master' into use-symbols-for-build-status-new

0db4e4e

NotMyFault mentioned this pull request Nov 25, 2023

Test core/8705 jenkinsci/acceptance-test-harness#1427

Closed

NotMyFault added the ath-successful This PR has successfully passed the full acceptance-test-harness suite label Nov 25, 2023

NotMyFault approved these changes Nov 25, 2023

View reviewed changes

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 Nov 25, 2023

mawinter69 suggested changes Nov 25, 2023

View reviewed changes

timja removed the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Nov 25, 2023

Address missed icons

9cbbac1

mawinter69 approved these changes Nov 26, 2023

View reviewed changes

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 Nov 26, 2023

NotMyFault merged commit 1f95b09 into jenkinsci:master Nov 27, 2023
17 checks passed

janfaracik deleted the use-symbols-for-build-status-new branch November 27, 2023 20:49

This was referenced Nov 29, 2023

Update dependency org.jenkins-ci.main:jenkins-war to v2.434 jenkinsci/bom#2704

Merged

AggregatedTestResultPublisherTest fails with Jenkins 2.434 jenkinsci/junit-plugin#588

Closed

MarkEWaite mentioned this pull request Nov 29, 2023

Remove JUnit plugin AggregatedTestResultPublisherTest exclusion jenkinsci/bom#2705

Closed

NotMyFault reviewed Dec 5, 2023

View reviewed changes

mawinter69 reviewed Dec 5, 2023

View reviewed changes

janfaracik mentioned this pull request Dec 10, 2023

"Aborted" icon is almost invisible jenkinsci/dark-theme-plugin#399

Open

uhafner reviewed Dec 23, 2023

View reviewed changes

mawinter69 mentioned this pull request Jan 31, 2024

make it compatible with 2.401.1 jenkins jenkinsci/pipeline-agent-build-history-plugin#14

Closed

daniel-beck mentioned this pull request Feb 16, 2024

[JENKINS-72711] Restore progress animation in build history and buildtime trend views #8966

Merged

uhafner mentioned this pull request Feb 29, 2024

Remove icon from reference link as it is broken in core again jenkinsci/warnings-ng-plugin#1697

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use symbols for build status #8705

Use symbols for build status #8705

janfaracik commented Nov 20, 2023

Submitter checklist

Maintainer checklist

timja commented Nov 24, 2023

janfaracik commented Nov 24, 2023 •

edited

timja commented Nov 24, 2023

janfaracik commented Nov 24, 2023

timja left a comment

NotMyFault left a comment

timja commented Nov 25, 2023

mawinter69 left a comment •

edited

mawinter69 commented Nov 25, 2023

janfaracik commented Nov 26, 2023 •

edited

timja commented Nov 26, 2023

MarkEWaite commented Nov 29, 2023 •

edited

NotMyFault Dec 5, 2023

mawinter69 Dec 5, 2023

mawinter69 Dec 5, 2023

uhafner Dec 23, 2023 •

edited

uhafner commented Jan 4, 2024

daniel-beck commented Feb 14, 2024

daniel-beck commented Mar 11, 2024

Use symbols for build status #8705

Use symbols for build status #8705

Conversation

janfaracik commented Nov 20, 2023

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

timja commented Nov 24, 2023

janfaracik commented Nov 24, 2023 • edited

timja commented Nov 24, 2023

janfaracik commented Nov 24, 2023

timja left a comment

Choose a reason for hiding this comment

NotMyFault left a comment

Choose a reason for hiding this comment

timja commented Nov 25, 2023

mawinter69 left a comment • edited

Choose a reason for hiding this comment

mawinter69 commented Nov 25, 2023

janfaracik commented Nov 26, 2023 • edited

timja commented Nov 26, 2023

MarkEWaite commented Nov 29, 2023 • edited

NotMyFault Dec 5, 2023

Choose a reason for hiding this comment

mawinter69 Dec 5, 2023

Choose a reason for hiding this comment

mawinter69 Dec 5, 2023

Choose a reason for hiding this comment

uhafner Dec 23, 2023 • edited

Choose a reason for hiding this comment

uhafner commented Jan 4, 2024

daniel-beck commented Feb 14, 2024

daniel-beck commented Mar 11, 2024

janfaracik commented Nov 24, 2023 •

edited

mawinter69 left a comment •

edited

janfaracik commented Nov 26, 2023 •

edited

MarkEWaite commented Nov 29, 2023 •

edited

uhafner Dec 23, 2023 •

edited