Esri / calcite-design-system

A monorepo containing the packages for Esri's Calcite Design System
https://developers.arcgis.com/calcite-design-system/
Other
295 stars 76 forks source link

Document `@stencil/core` dependency changes in the changelog #6729

Open ethanbdev opened 1 year ago

ethanbdev commented 1 year ago

Description

If we (another stencil project) are using calcite components, the stencil version number needs to be in sync to maintain full types for the components. This is noted in the readme: https://github.com/Esri/calcite-components#stencilcore-version

It would be great if the stencil version update was noted in the changelog, making it easier to find when it changes. Some other libraries do this with supported typescript version, etc.

For example, v1.2.0 updated to @stencil/core: 2.22.3, but this was not noted.

Which Component

n/a

Resources

No response

geospatialem commented 1 year ago

@jcfranco WDYT if we added the "feat" conventional commit to our core dependencies so the changes are reflected in our changelog?

It looks like we could update some of our dependabot CI to reflect those changes, if you agree?

We could also potentially create a separate (new) dependabot.yml file for certain use cases we'd like to add to the changelog?

jcfranco commented 1 year ago

Making these updates more transparent is a great idea. 🚀

geospatialem commented 1 year ago

This is a limitation of dependabot - we plan to investigate Renovate as an opportunity to automate this process with https://github.com/Esri/calcite-components/issues/5746 in June.

In the meantime, as we install updates to @floating-ui/dom and @stencil/core, we will change the conventional commit from "build(deps): " to "feat(floating-ui): "/"feat(stencil): " to update the release notes.

Will also add an update to the release notes to our developers site, for inclusion in next week's doc release.

geospatialem commented 7 months ago

For consideration as part of the update, would all be nice to mention when update the following deps: