chore: 6.x stable checklist
6.0 stable checklist
- [x] mark component beta/stable tags
- [x] mark breaking api changes on changelog https://github.com/vmware-clarity/core/releases
- [ ] cut beta/stable for preparation for angular 14 release https://github.com/vmware-clarity/ng-clarity/issues/95
- [ ] enable shim by default for
@clr/angularsee https://github.com/vmware-clarity/ng-clarity/issues/95 - [x] ensure storybook deployment applies to https://clarity.design/storybook/core
- [ ] after deployment mark the v4
@clr/core,@clr/reactand@clr/angularpackages as deprecated in npm
As of v6, if using rollup (or vite, which uses rollup), you may need the @rollup/plugin-node-resolve package in your rollup config. https://github.com/vmware-clarity/core/issues/100
Adding a few elements here, in case it's helpful for a comprehensive upgrade guide:
-
v6's deprecated
CdsInlineButtondoesn't work right on its own as the styling is incorrect. This gets resolved if a singleCdsButtonInlinegets imported in the project. We resolved this by renaming ourCdsInlineButtonintoCdsButtonInline(which could use a mention in the upgrade guide) -
This same
CdsInlineButtondoes not render itsrolecorrectly. Same resolution as above. -
We use an ℹ️ icon as input action, and it is now misaligned:
(v6) vs.
(v5)
See #87 for more context -
Internal components have been renamed so you might want to mention that in an upgrade guide. I realize they're supposed to be internal, but I opened a discussion about it since one of them were introduced for us (therefore not internal): https://github.com/vmware-clarity/core/discussions/94
-
Upgrade guide should mention the CSS shims in Core must be removed.