User Story
As a user of the Solid Design System, I want the changelogs to clearly explain what has changed in each package so I can easily understand the impact on my work.
Current Behaviour
With the introduction of multi‑theming, interdependent packages (components, styles, and tokens) must now have synchronized version numbers. As a result, some packages display updated version numbers in their changelogs even when no direct changes were made to them. The actual changes occur in a related package, but this is not reflected clearly.
This creates changelogs that provide little useful information and make it difficult for users to understand what actually changed.
Suggested Solution
Improve the changelog generation so that packages which are version‑bumped only due to upstream dependency changes still include meaningful context in their changelogs.
Instead of showing a bare version number with no explanation, the changelog generator should automatically add a short note whenever a package has no direct changes of its own.
This can be implemented by adding a custom Changesets changelog function that detects when:
- a package has no changeset summary, and/or
- a package was bumped only because a dependency changed and then injects a standard explanatory message.
This will likely require creating a wrapper around the existing changesets-changelog-clean formatter so that we can retain its current formatting while layering in the additional functionality.
DoR
User Story
As a user of the Solid Design System, I want the changelogs to clearly explain what has changed in each package so I can easily understand the impact on my work.
Current Behaviour
With the introduction of multi‑theming, interdependent packages (components, styles, and tokens) must now have synchronized version numbers. As a result, some packages display updated version numbers in their changelogs even when no direct changes were made to them. The actual changes occur in a related package, but this is not reflected clearly.
This creates changelogs that provide little useful information and make it difficult for users to understand what actually changed.
Suggested Solution
Improve the changelog generation so that packages which are version‑bumped only due to upstream dependency changes still include meaningful context in their changelogs.
Instead of showing a bare version number with no explanation, the changelog generator should automatically add a short note whenever a package has no direct changes of its own.
This can be implemented by adding a custom Changesets changelog function that detects when:
This will likely require creating a wrapper around the existing
changesets-changelog-cleanformatter so that we can retain its current formatting while layering in the additional functionality.DoR