-
Notifications
You must be signed in to change notification settings - Fork 235
chore: make changelog generation work for multiple packages and update changeset docs #5795
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
base: barebones
Are you sure you want to change the base?
Conversation
|
📚 Branch Preview🔍 Visual Regression Test ResultsWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
Deployed to Azure Blob Storage: If the changes are expected, update the |
Tachometer resultsCurrently, no packages are changed by this PR... |
|
Is it a good idea to create a approach document before we add these changes or are you planning to add it in the description root of this PR? |
56bf0c9 to
c522607
Compare
This is being tackled in SWC-1234. We can wait for those docs! |
Update: we agreed to not keep this one blocked, separate both concerns and revisit documentation post-barebones (e.g., how to surface this and other docs in the unified place). |
Description
Refactored and updated the current global changelog generation script (
first-gen/scripts/update-global-changelog.js) to allow generating a 2nd-gen global changelog.Updated the changesets README documentation to provide guidance for creating changesets in the new monorepo structure considering both first-gen and second-gen packages.
Motivation and context
The monorepo structure now includes both first-gen Spectrum Web Components and second-gen @swc/core packages, but the changeset documentation didn't provide clear guidance on how to create changesets for this new structure nor did the global changelog script support it.
Related issue(s)
Screenshots (if appropriate)
N/A - Internal tooling improvement
Author's checklist
Reviewer's checklist
patch,minor, ormajorfeaturesManual review test cases
Test changelog generation for first-gen components
yarn changesetand create a changeset with@spectrum-web-components/button: minornode first-gen/scripts/update-global-changelog.jsTest changelog generation for @swc/core packages
yarn changesetand create a changeset with@swc/core: patchnode first-gen/scripts/update-global-changelog.jsTest changeset documentation clarity
.changeset/README.mdTest script error handling