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

feat(editor): Use a single SVG for logo and favicon (no-changelog) #11811

Merged
merged 5 commits into from
Dec 16, 2024

Conversation

netroy
Copy link
Member

@netroy netroy commented Nov 20, 2024

Summary

This PR

  1. Deletes 9 logo variants files
  2. Adds a 2 new SVGs to generate all the variants programatically
  3. Consolidates all logo related code into a single place, and adds tests for it
  4. For non-stable releases, copies over the logo svg into the favicon as well

Related Linear tickets, Github issues, and Community forum posts

Review / Merge checklist

  • PR title and summary are descriptive. (conventions)
  • Docs updated or follow-up ticket created.
  • Tests included.
  • PR Labeled with release/backport (if the PR is an urgent fix that needs to be backported)

@n8n-assistant n8n-assistant bot added n8n team Authored by the n8n team ui Enhancement in /editor-ui or /design-system labels Nov 20, 2024
@MiloradFilipovic MiloradFilipovic self-requested a review November 21, 2024 08:05
Copy link
Contributor

@MiloradFilipovic MiloradFilipovic left a comment

Choose a reason for hiding this comment

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

Nice cleanup 🙌🏻
A few points from my side:

  • Can we make this a design-system component? Current implementation includes a few specific things, like releaseChannel and location that we can abstract away and pass color, showLogoText and showReleaseChannelTag as props
  • Maybe also moving logo creation logic from onMounted into a composable would make it easier to mock in the test if there is no other workaround for jsdom issue

@netroy netroy force-pushed the inline-svg-logo-and-favicon branch from 35a6a7a to 780acc0 Compare November 25, 2024 14:42
@netroy netroy force-pushed the inline-svg-logo-and-favicon branch 2 times, most recently from bae1a2f to ca08169 Compare November 25, 2024 16:09
Copy link

codecov bot commented Nov 25, 2024

Codecov Report

Attention: Patch coverage is 95.08197% with 3 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
packages/editor-ui/src/components/Logo/Logo.vue 93.02% 3 Missing ⚠️

📢 Thoughts on this report? Let us know!

Copy link
Contributor

@MiloradFilipovic MiloradFilipovic left a comment

Choose a reason for hiding this comment

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

This looks good. One more question but feel free to ignore it:
Any reason against moving Logo.vue to design-system? In that case I think we can remove the location prop since it's too specific to editor-ui and maybe pass showReleaseChannelTag as a prop.

Copy link
Contributor

⚠️ Some Cypress E2E specs are failing, please fix them before merging

Copy link

cypress bot commented Nov 27, 2024

n8n    Run #8343

Run Properties:  status check passed Passed #8343  •  git commit 89a6fe3469: 🌳 🖥️ browsers:node18.12.0-chrome107 🤖 netroy 🗃️ e2e/*
Project n8n
Branch Review inline-svg-logo-and-favicon
Run status status check passed Passed #8343
Run duration 04m 36s
Commit git commit 89a6fe3469: 🌳 🖥️ browsers:node18.12.0-chrome107 🤖 netroy 🗃️ e2e/*
Committer कारतोफ्फेलस्क्रिप्ट™
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 1
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 480
View all changes introduced in this branch ↗︎

Copy link
Contributor

✅ No visual regressions found.

Copy link
Contributor

✅ All Cypress E2E specs passed

@netroy netroy merged commit 4ae6049 into master Dec 16, 2024
40 checks passed
@netroy netroy deleted the inline-svg-logo-and-favicon branch December 16, 2024 09:31
@janober
Copy link
Member

janober commented Dec 19, 2024

Got released with n8n@1.73.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
n8n team Authored by the n8n team Released ui Enhancement in /editor-ui or /design-system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants