core icon indicating copy to clipboard operation
core copied to clipboard

chore: 6.x stable checklist

Open coryrylan opened this issue 4 years ago • 2 comments

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/angular see 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/react and @clr/angular packages as deprecated in npm

coryrylan avatar Apr 21 '22 21:04 coryrylan

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

ashleyryan avatar Jun 22 '22 13:06 ashleyryan

Adding a few elements here, in case it's helpful for a comprehensive upgrade guide:

  • v6's deprecated CdsInlineButton doesn't work right on its own as the styling is incorrect. This gets resolved if a single CdsButtonInline gets imported in the project. We resolved this by renaming our CdsInlineButton into CdsButtonInline (which could use a mention in the upgrade guide)

  • This same CdsInlineButton does not render its role correctly. Same resolution as above.

  • We use an ℹ️ icon as input action, and it is now misaligned: Screen Shot 2022-05-25 at 2 12 08 PM (v6) vs. Screen Shot 2022-05-25 at 2 12 25 PM (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.

astorije avatar Jun 22 '22 21:06 astorije