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: Update chromicons and icon typings #416

Merged
merged 3 commits into from
Jun 17, 2024
Merged

Conversation

hewayman
Copy link
Contributor

The icon typings here need to be updated so the latest version of chromicons can be used in PHC-UI.

Copy link
Contributor

@swain swain left a comment

Choose a reason for hiding this comment

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

Is this a breaking change to the types?

@hewayman
Copy link
Contributor Author

Is this a breaking change to the types?

@swain I was trying to avoid breaking anything. This change reflects the correct types in the newest version of chromicons. I can't update chromicons in PHC-UI without breaking anything (because of the mismatched types), so I was updating the types here first. I thought the changes here would be released as a new version, so then I could use the newer versions of chromicons and chroma-react at the same time in PHC-UI. Is there a better way to handle this?

@swain
Copy link
Contributor

swain commented Jun 17, 2024

@hewayman Your logic all makes sense to me. Only reason I asked: if this is a breaking change, we should mark it as such with a major version bump.

You can do that by adding a new commit (or amending your existing one) to match this message syntax:

feat!: blah blah blah

The ! marks the commit as a breaking change, and will cause semantic-release to release this change as a major version bump.

Copy link
Contributor

@sternetj sternetj left a comment

Choose a reason for hiding this comment

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

Swain means a breaking change as in the API is changing which means when consumers of this library upgrade their version of chroma-react, they will need to make some change.

I think we should consider this breaking. I think we should update the peer dependencies to reference the lowest version of chromicons that had the API change, v3.0.0.

A "breaking change" really just means we need to bump the major version of the library. This can be done by commenting with an exclamation mark in the commit after the semmantic tag. i.e. feat!: Update the peer dependency for chromicons

@hewayman
Copy link
Contributor Author

@swain @sternetj That makes sense. I missed the note about ! in the docs. I'll do that and update the peer dependencies to 3.0.0. Thanks

@lifeomic-probot
Copy link

⚠️ Detected a breaking change in commit 8f2ce90

Merging this PR will result in a major version bump.

Created by lifeomic-probot (Enforce Semantic Commits)

@hewayman hewayman merged commit 13f5b9e into master Jun 17, 2024
7 checks passed
@hewayman hewayman deleted the NO-JIRA-upgrade-chromicons branch June 17, 2024 15:25
Copy link

🎉 This PR is included in version 6.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants