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

Add support for Apple touch bar icons #6768

Merged
merged 10 commits into from
Aug 30, 2022

Conversation

NotMyFault
Copy link
Member

@NotMyFault NotMyFault commented Jul 3, 2022

Adds support for Apple's touch bar icons and drops obsolete shortcut tag, as per the MDN docs.

Proposed changelog entries

  • Add support for Apple's touch bar icons.

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.
  • 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 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).

@NotMyFault NotMyFault added the rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted label Jul 3, 2022
@NotMyFault NotMyFault requested a review from a team July 3, 2022 22:21
@timja
Copy link
Member

timja commented Jul 4, 2022

Oh cool I didn't know this was a thing, good info in https://medium.com/swlh/are-you-using-svg-favicons-yet-a-guide-for-modern-browsers-836a6aace3df

(not tested yet)

@daniel-beck
Copy link
Member

What's the favicon used on pages not using l:layout? Would that still be .ico?

@NotMyFault
Copy link
Member Author

What's the favicon used on pages not using l:layout? Would that still be .ico?

Do you have a view or example page at hand for this case? The pages I viewed use the replace favicon fine.

@daniel-beck
Copy link
Member

/env-vars.html/ before #6096 comes to mind. Given how recent that change is, it's reasonable to expect there to be more such pages.

A simple (but perhaps not that relevant) example in current core might be directly accessed help pages, like https://ci.jenkins.io/help/system-config/homeDirectory.html

@NotMyFault
Copy link
Member Author

NotMyFault commented Jul 4, 2022

/env-vars.html/ before #6096 comes to mind. Given how recent that change is, it's reasonable to expect there to be more such pages.

This page picks up the favicon replacement fine.

A simple (but perhaps not that relevant) example in current core might be directly accessed help pages, like https://ci.jenkins.io/help/system-config/homeDirectory.html

No favicon here. I didn't know about this page before, but it looks quite ancient.
If not available, a more appealing documentation may be available on jenkins.io 👀

@timja
Copy link
Member

timja commented Jul 4, 2022

No favicon here. I didn't know about this page before, but it looks quite ancient.

Those pages are just the help pages themselves that are displayed inline, you can directly access them via URL.
They would never normally be accessed directly, not a real test really.

@daniel-beck
Copy link
Member

I'm not going to look for a plugin that renders some pages without l:layout. I would be very surprised if there isn't.

This PR, for no reason at all, makes the UI worse in some (rare) situations. Why is that not enough?

@daniel-beck
Copy link
Member

Out of curiosity, where do RSS feeds get their favicon from?

@NotMyFault
Copy link
Member Author

I'm not going to look for a plugin that renders some pages without l:layout. I would be very surprised if there isn't.

This PR, for no reason at all, makes the UI worse in some (rare) situations. Why is that not enough?

I restored the .ico type browsers will pick up in such a case or if they don't support svg favicons yet.

Copy link
Member

@daniel-beck daniel-beck left a comment

Choose a reason for hiding this comment

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

Looks like these would also need restoring?

IIRC, the favicon.ico is allowed on resource root URL so that browsers that request it don't spam all possible logs with errors (and would apply to plain text files etc. as well). That got annoying quickly.

@NotMyFault NotMyFault requested a review from daniel-beck July 4, 2022 12:04
@NotMyFault
Copy link
Member Author

Looks like these would also need restoring?

I committed your suggestions, are there outstanding concerns left?

@NotMyFault NotMyFault requested a review from a team August 23, 2022 20:44
@NotMyFault NotMyFault requested a review from a team August 23, 2022 21:54
Copy link
Member

@basil basil 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. Please see the merge process documentation for more information about the merge process. Thanks!

@basil basil added ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback squash-merge-me Unclean or useless commit history, should be merged only with squash-merge labels Aug 29, 2022
@basil basil merged commit 70516d6 into jenkinsci:master Aug 30, 2022
@NotMyFault NotMyFault changed the title feat: Add support for Apple touch bar icons Add support for Apple touch bar icons Aug 31, 2022
ala-ableton added a commit to ala-ableton/simple-theme-plugin that referenced this pull request May 2, 2023
Since jenkinsci/jenkins#6768, there is an
"alternate icon" element that needs to be removed as well.
TobiX added a commit to jenkinsci/simple-theme-plugin that referenced this pull request May 3, 2023
* Fix favicon support in Chrome with Jenkins 2.367 and later

Since jenkinsci/jenkins#6768, there is an
"alternate icon" element that needs to be removed as well.

* Simplify

---------

Co-authored-by: Tobias Gruetzmacher <[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 squash-merge-me Unclean or useless commit history, should be merged only with squash-merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants