Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add script to generate component changelog entries #2613

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

alex-ju
Copy link
Member

@alex-ju alex-ju commented Dec 18, 2024

πŸ“Œ Summary

This PR proposes a set of changes aiming to automate the component changelog entries.

πŸ› οΈ Detailed description

Group component changelog entries in a single markdown file

For illustration, I did this for the components updated in 4.15.0. If agreed I will update the rest of the components.

- @include "partials/version-history/4.15.0.md"
- @include "partials/version-history/4.10.0.md"
+ @include "partials/version-history/version-history.md"

Update the main component changelog to follow convention

Adjusted a few changelog entries in 4.15.0. I propose we follow a one-line format moving forward, as much as possible, to make the automation more reliable:

`Component` - Added `@argument` to `Component::Subcomponent`
`Component` - Fixed something
`Component` - Deprecated `@oldArgument`

Add script to generate component changelog entries

Running the following command in changeset-release/main when preparing to release will append changelog entries to each component, as shown in e4dcdd6.

yarn run generate-component-changelog-entries

Once the component changelogs are generated they can be adjusted as needed before committing to the changeset branch.

πŸ”— External links

Jira ticket: HDS-4215


πŸ’¬ Please consider using conventional comments when reviewing this PR.

Copy link

vercel bot commented Dec 18, 2024

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Updated (UTC)
hds-showcase βœ… Ready (Inspect) Visit Preview Dec 18, 2024 11:35am
hds-website βœ… Ready (Inspect) Visit Preview Dec 18, 2024 11:35am

@hashibot-hds hashibot-hds added packages/components docs-website Content updates to the documentation website labels Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website packages/components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants