search

primer / octicons

A scalable set of icons handcrafted with <3 by GitHub
https://primer.style/foundations/icons
MIT License
8.34k stars 829 forks source link

Rename some wrongly named icons #1023

Open lukasoppermann opened 7 months ago

lukasoppermann commented 7 months ago

We have other icons like circle and circle-slash. In Figma these icons are also called circle-check. It feels wrong to invert the naming logic for this one icon.

The alternative would be to go the other way and rename the remaining icons and all figma icons to [thing]-circle.

[!Warning] Warning: This is probably a breaking change. We could mitigate this by:

  1. Releasing the renamed and old icons in a minor update.
  2. Remove the badly named icons in a major release
  3. Search and replace all instances we find on github and primer.
changeset-bot[bot] commented 7 months ago

⚠️ No Changeset found

Latest commit: 327f703c7958ffe2f0ce76a13c5b6c520421670b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions[bot] commented 3 months ago

Hi! This pull request has been marked as stale because it has been open with no activity for 60 days. You can comment on the pull request or remove the stale label to keep it open. If you do nothing, this pull request will be closed in 7 days.

lukasoppermann commented 3 hours ago

@camertron, pinging you as I hope you can help.

We are currently in a tough spot, were renaming icons is nearly impossible, as we need to update the entire consuming project at the same time.

I think we need an approach that allows us to deprecate icons but keep them in package somehow.

Basically, having two versions of an icon, but one comes from a deprecated folder?

I don't know if we can log a console message for deprecated icons, e.g. `The icon "iconName-16" is deprecated, please use "newIconName-16" instead.

This would allow us to have both versions in the package at the same time, so that we can update the consumers and remove the icons in a next major. Any thoughts?