search

lifeomic / chroma-react

Open source design system from LifeOmic, built with React
https://lifeomic.github.io/chroma-react/
MIT License
48 stars 9 forks source link

feat: Update chromicons and icon typings #416

Closed hewayman closed 2 months ago

hewayman commented 2 months ago

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

hewayman commented 2 months ago

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 commented 2 months ago

@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.

hewayman commented 2 months ago

@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[bot] commented 2 months ago

⚠️ Detected a breaking change in commit 8f2ce90

Merging this PR will result in a major version bump.

Created by lifeomic-probot (Enforce Semantic Commits)

github-actions[bot] commented 2 months ago

:tada: This PR is included in version 6.0.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: