Add the possibility to allow the user to have a favicon which differs from the main logo #18542

je-s · 2022-02-02T02:03:41Z

⚠️ BREAKING ⚠️

This change breaks users' current favicon configuration. Since we're replacing the path in the HTML file, Gitea will fall back to the standard Gitea logo for the favicon.
In order to fix this, users need to re-run the steps described in Customizing Gitea.
In short: The users need to copy their current logo.svg to favicon.svg, re-run make generate-images, and place the files in the folder accordingly as described in the guide linked above.

As described in #18541, this change allows the user to have a favicon which differs from his main logo.
In order to not break existing stuff, I've added/copied the icon.svg to favicon.svg. I've also adjusted the "Customizing Gitea" page already.

This allows the user to have a favicon which differs from the logo.

This is needed to accommodate the changes for allowing the user to have a differing logo and favicon

docs/content/doc/advanced/customizing-gitea.en-us.md

silverwind · 2022-02-02T03:06:46Z

generate-images.js needs to be update to generate favicon.png from the favicon.svg source.

This is a breaking change for users of custom icons in any case because of the different HTTP filename.

silverwind · 2022-02-02T03:12:07Z

Also, you need to alter generate-images.js so it actually copies the new file into public/img.

…ges.js

Co-authored-by: silverwind <me@silverwind.io>

…ons.svg file This belongs to PR go-gitea#18542.

je-s · 2022-02-02T13:56:51Z

Hey @silverwind,

adjusted that, makes total sense. The changes are also tested and work as intended.

Regarding the breaking of currently customised favicons:
Would it make sense to pick that up as a pinned issue, so people know what to do as soon as they encounter it for the next few months? I mean, basically they just need to re-run the script and upload the files to their public folder.
And secondly, would it maybe make sense to make the setting/uploading of logos available via UI? (Like Nextcloud does it, for instance.) I'd make a separate issue for that then to discuss that matter.

zeripath · 2022-02-02T22:08:16Z

as per the CONTRIBUTING.md:

If your PR could cause a breaking change you must add a BREAKING section to the opening comment e.g.:

## :warning: BREAKING :warning:

... explain how this is breaking and how to fix ...

To explain how this could affect users and how to mitigate these changes.

je-s · 2022-02-03T12:43:16Z

I've added a clearer description of how generate-images works now.

stale · 2022-04-16T11:06:55Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs during the next 2 months. Thank you for your contributions.

je-s · 2022-05-10T19:50:56Z

Is there anything left to be done to get it included into 1.17.0?
If so I'll definitely do it. I've seen that it's currently stuck at being reviewed by two people.

silverwind · 2022-05-10T20:03:35Z

Maybe update the PR description once more with instructions for users that had used the previous single source file, e.g. that they now have to copy their logo.svg to favicon.svg to achieve the previous outcome.

lunny · 2022-05-11T00:46:24Z

Please resolve the conflicts

je-s · 2022-05-11T18:03:47Z

@lunny Done, conflicts resolved.

techknowlogick · 2022-05-11T18:07:47Z

Thanks @je-s, the linting is failing on the head.tmpl due to mix use of tabs v spaces. If you have time to send a new commit to resolve I can merge now, otherwise I can update your branch later with the fix.

je-s · 2022-05-11T18:20:45Z

@techknowlogick Should be fine now, done.
@silverwind I've added a short description regarding how to solve that issue, additionally to the link where the (updated) guide can be found. I guess if we're linking/hinting that in the release notes, it should be clear enough.

silverwind · 2022-05-11T18:44:51Z

Something is wrong with your merge, the window.config section should not be in templates/base/head.tmpl, it was extracted to a separate file a while ago. Don' merge until resolved.

silverwind

merge needs to be fixed.

lafriks

Blocking until failed merge is fixed

je-s · 2022-05-11T23:50:04Z

@lafriks @silverwind Yeah, this old section got falsely included. I've removed the window.config script section to reflect the current state again. I think we should be good now finally. :)

failed merge is fixed

wxiaoguang · 2022-05-20T02:57:35Z

If there is nothing more left to do, this PR will be merged in 2 days (some more open days, in case some people want to improve it).

* giteaofficial/main: [skip ci] Updated translations via Crowdin Add the possibility to allow the user to have a favicon which differs from the main logo (go-gitea#18542)

… from the main logo (go-gitea#18542) * Changed the filename of the favicon SVG This allows the user to have a favicon which differs from the logo. * Added favicon.svg This is needed to accommodate the changes for allowing the user to have a differing logo and favicon * Adjusted page to accommodate what icon is used as favicon * Added functionality to also generate the favicon.svg via generate-images.js * Adjusted the description for the new favicon compatibility Co-authored-by: silverwind <me@silverwind.io> * Updated generate-images.js to generate favicons from a separate favicons.svg file This belongs to PR go-gitea#18542. * Added description on how custom favicons can be generated * Replaced space indents with tabs * Synced changes with current state of the file * Synced changes with current state of the file Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: zeripath <art27@cantab.net> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: Lauris BH <lauris@nix.lv>

je-s added 3 commits February 2, 2022 02:50

Changed the filename of the favicon SVG

bf0d096

This allows the user to have a favicon which differs from the logo.

Added favicon.svg

b8e6208

This is needed to accommodate the changes for allowing the user to have a differing logo and favicon

Adjusted page to accommodate what icon is used as favicon

a0ef073

je-s mentioned this pull request Feb 2, 2022

Enable the possibility to load a favicon which differs from the logo #18541

Closed

techknowlogick changed the title ~~Add the possibility to allow the user to have a favicon which differs from the main logo (#18541)~~ Add the possibility to allow the user to have a favicon which differs from the main logo Feb 2, 2022

silverwind reviewed Feb 2, 2022

View reviewed changes

docs/content/doc/advanced/customizing-gitea.en-us.md Outdated Show resolved Hide resolved

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Feb 2, 2022

silverwind added the pr/breaking Merging this PR means builds will break. Needs a description what exactly breaks, and how to fix it! label Feb 2, 2022

silverwind added this to the 1.17.0 milestone Feb 2, 2022

je-s and others added 3 commits February 2, 2022 14:22

Added functionality to also generate the favicon.svg via generate-ima…

6751a9d

…ges.js

Adjusted the description for the new favicon compatibility

c0866a9

Co-authored-by: silverwind <me@silverwind.io>

Updated generate-images.js to generate favicons from a separate favic…

8acebd5

…ons.svg file This belongs to PR go-gitea#18542.

zeripath and others added 2 commits February 2, 2022 22:08

Merge branch 'main' into main

ed09f74

Added description on how custom favicons can be generated

f66280c

Merge branch 'main' into main

bd4b30b

stale bot added the issue/stale label Apr 16, 2022

stale bot removed the issue/stale label May 10, 2022

silverwind approved these changes May 10, 2022

View reviewed changes

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels May 10, 2022

lunny approved these changes May 11, 2022

View reviewed changes

GiteaBot removed the lgtm/need 1 This PR needs approval from one additional maintainer to be merged. label May 11, 2022

GiteaBot added the lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. label May 11, 2022

Merge branch 'main' into main

9f78001

Replaced space indents with tabs

78bd12b

silverwind requested changes May 11, 2022

View reviewed changes

lafriks previously requested changes May 11, 2022

View reviewed changes

je-s added 2 commits May 12, 2022 01:34

Synced changes with current state of the file

77ca244

Synced changes with current state of the file

10b42c8

je-s requested review from lafriks and silverwind May 11, 2022 23:47

silverwind approved these changes May 12, 2022

View reviewed changes

lunny added 2 commits May 12, 2022 15:07

Merge branch 'main' into main

354e2d2

Merge branch 'main' into main

c89d73e

Merge branch 'main' into main

c3d2259

lafriks approved these changes May 23, 2022

View reviewed changes

lunny merged commit b65ad70 into go-gitea:main May 23, 2022

kousu mentioned this pull request May 25, 2022

Praxis Data Server (https://spineimage.ca) neuropoly/data-management#77

Open

go-gitea locked and limited conversation to collaborators May 3, 2023

GiteaBot added the kind/breaking label Oct 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add the possibility to allow the user to have a favicon which differs from the main logo #18542

Add the possibility to allow the user to have a favicon which differs from the main logo #18542

je-s commented Feb 2, 2022 •

edited

silverwind commented Feb 2, 2022 •

edited

silverwind commented Feb 2, 2022 •

edited

je-s commented Feb 2, 2022

zeripath commented Feb 2, 2022

je-s commented Feb 3, 2022

stale bot commented Apr 16, 2022

je-s commented May 10, 2022

silverwind commented May 10, 2022

lunny commented May 11, 2022

je-s commented May 11, 2022

techknowlogick commented May 11, 2022

je-s commented May 11, 2022

silverwind commented May 11, 2022 •

edited

silverwind left a comment

lafriks left a comment

je-s commented May 11, 2022

wxiaoguang commented May 20, 2022

Add the possibility to allow the user to have a favicon which differs from the main logo #18542

Add the possibility to allow the user to have a favicon which differs from the main logo #18542

Conversation

je-s commented Feb 2, 2022 • edited

⚠️ BREAKING ⚠️

silverwind commented Feb 2, 2022 • edited

silverwind commented Feb 2, 2022 • edited

je-s commented Feb 2, 2022

zeripath commented Feb 2, 2022

je-s commented Feb 3, 2022

stale bot commented Apr 16, 2022

je-s commented May 10, 2022

silverwind commented May 10, 2022

lunny commented May 11, 2022

je-s commented May 11, 2022

techknowlogick commented May 11, 2022

je-s commented May 11, 2022

silverwind commented May 11, 2022 • edited

silverwind left a comment

Choose a reason for hiding this comment

lafriks left a comment

Choose a reason for hiding this comment

je-s commented May 11, 2022

wxiaoguang commented May 20, 2022

je-s commented Feb 2, 2022 •

edited

silverwind commented Feb 2, 2022 •

edited

silverwind commented Feb 2, 2022 •

edited

silverwind commented May 11, 2022 •

edited