Customizable favicon

What does this MR do?

Allows changing the default favicon to a custom icon. The CI status favicons are generated from the original image as well.

• Upload custom favicon in appearance settings
• Main favicon is replaced by the custom one
• All CI status favicons are generated from the uploaded image

Are there points in the code the reviewer needs to double check?

Why was this MR needed?

GitLab already allows to customize the login screen and the header logo. Allowing to customize the favicon as well greatly helps differentiating the different GitLab instances.

The development of this MR is sponsored by @ siemens (/cc @bufferoverflow).

Screenshots (if relevant)

Appearance settings

CI status icon

Does this MR meet the acceptance criteria?

• Changelog entry added, if necessary
• Documentation created/updated
• API support added
• Tests added for this feature/bug
• Review
  • Has been reviewed by UX
  • Has been reviewed by Frontend
  • Has been reviewed by Backend
  • Has been reviewed by Database
• Conform by the merge request performance guides
• Conform by the style guides
• Squashed related commits together

What are the relevant issue numbers?

Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/15661

Could I get the favicon overlays that are used for the ci status favicons (e.g. favicon_status_canceled.ico please (maybe @dimitrieh?)? They are needed to generate the custom CI status favicons.

@marin What do you think about the GraphicsMagick dependency for this feature (related: https://gitlab.com/gitlab-org/gitlab-ce/issues/34364#note_34153762)? Is this acceptable? Should this dependency be documented? Or added to Omnibus?

restored source branch feature/customizable-favicon

@koffeinfrei in what way do you want them? .ico .png .svg etc?

I exported them with the tanuki icon, as 32px x 32px png's after which i converted them with http://www.favicomatic.com/

If you want to fiddle with it yourself, you can find the sketch file in https://gitlab.com/gitlab-org/gitlab-design/blob/master/progress/dimitrie/misc-application-wide/25564-status-badges.sketch

in what way do you want them? .ico .png .svg etc?

@dimitrieh .png should be fine, as 32x32. I'll just need the (currently 10) overlay icons with transparent bg to generate the custom favicons on the fly.

@koffeinfrei here you go, or download them as a zip: Archive.zip

@koffeinfrei currently we have hardcoded these icons into the favicons with the tanuki icon. We do this for both the gdk-ce/gdk-ee/gitlab itself and another one i believe.. Ending up with a lot of icons.

It would be great if this MR makes that a little more maintainable

cc: @timzallmann

@dimitrieh Great! Thank you very much!

It would be great if this MR makes that a little more maintainable

I've been thinking about this as well. I'll see if I can come up with a nice solution that doesn't break the caching nor the asset pipeline nor the dev experience...

unmarked as a Work In Progress

changed the description

added Community Contribution UX frontend labels

marked the checklist item Tests added for this feature/bug as completed

mentioned in issue #15661 (moved)

What do you think about the GraphicsMagick dependency for this feature (related: https://gitlab.com/gitlab-org/gitlab-ce/issues/34364#note_34153762)? Is this acceptable? Should this dependency be documented? Or added to Omnibus?

Dependency should be documented and also added to Omnibus. Without it this feature won't work.

mentioned in issue omnibus-gitlab#2845

mentioned in merge request omnibus-gitlab!1975