Skip to content

Commit 5e35222

Browse files
chore: make changelog generation work for multiple packages and update changeset docs (#5795)
1 parent 2587303 commit 5e35222

File tree

3 files changed

+327
-153
lines changed

3 files changed

+327
-153
lines changed

.changeset/README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ find the full documentation for it [in our repository](https://github.com/change
88

99
Changesets are a way to manage versions and changelogs for monorepos. Each changeset:
1010

11-
- Describes changes made in one or more packages
12-
- Indicates the type of change (major, minor, patch)
13-
- Contains a brief markdown summary of the changes
11+
- Describes changes made in one or more packages
12+
- Indicates the type of change (major, minor, patch)
13+
- Contains a brief markdown summary of the changes
1414

1515
## How to Add a Changeset
1616

@@ -29,18 +29,25 @@ Changesets are a way to manage versions and changelogs for monorepos. Each chang
2929

3030
The command will create a new markdown file in the `.changeset` directory with your changes.
3131

32+
## Important: @swc/core and component updates
33+
34+
When making changes to `@swc/core`, you **must** also include the corresponding `@spectrum-web-components` component in the same changeset to ensure the changes appear in the component's changelog. This is because `@swc/core` changes are internal and don't automatically propagate to the component changelogs.
35+
36+
**Best practice**: Create a single changeset that includes both packages when updating core functionality that affects a specific component.
37+
3238
## Example Changeset
3339

3440
A typical changeset file looks like this:
3541

3642
```markdown
3743
---
44+
'@swc/core': patch
3845
'@spectrum-web-components/button': minor
3946
'@spectrum-web-components/theme': patch
4047
---
4148
42-
- **Added**: Added new variant `tertiary` to `<sp-button>` component [#9999](https://github.com/adobe/spectrum-web-components/pull/9999)
43-
- **Fixed**: Fixed `<sp-theme>` theme compatibility issues [#10000](https://github.com/adobe/spectrum-web-components/pull/10000)
49+
- **Added**: Added new variant `tertiary` to `<sp-button>` component [#9999](https://github.com/adobe/spectrum-web-components/pull/9999)
50+
- **Fixed**: Fixed `<sp-theme>` theme compatibility issues [#10000](https://github.com/adobe/spectrum-web-components/pull/10000)
4451
```
4552
4653
For our guidelines on writing changesets, see [our writing changesets guide](https://opensource.adobe.com/spectrum-web-components/guides/writing-changesets/).
@@ -61,6 +68,6 @@ We have a quick list of common questions to get you started engaging with this p
6168
6269
## Additional Resources
6370
64-
- [Changesets Documentation](https://github.com/changesets/changesets)
65-
- [Common Questions](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
66-
- [Detailed Release Process](https://github.com/changesets/changesets/blob/main/docs/detailed-explanation.md)
71+
- [Changesets Documentation](https://github.com/changesets/changesets)
72+
- [Common Questions](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
73+
- [Detailed Release Process](https://github.com/changesets/changesets/blob/main/docs/detailed-explanation.md)

.changeset/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
],
99
"commit": false,
1010
"fixed": [["@spectrum-web-components/*"]],
11-
"linked": [],
11+
"linked": [["@swc/components", "@swc/core"]],
1212
"access": "public",
1313
"baseBranch": "main",
1414
"updateInternalDependencies": "patch",

0 commit comments

Comments
 (0)