Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions .changeset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ find the full documentation for it [in our repository](https://github.com/change

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

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

## How to Add a Changeset

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

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

## Important: @swc/core and component updates

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.

**Best practice**: Create a single changeset that includes both packages when updating core functionality that affects a specific component.

## Example Changeset

A typical changeset file looks like this:

```markdown
---
'@swc/core': patch
'@spectrum-web-components/button': minor
'@spectrum-web-components/theme': patch
---

- **Added**: Added new variant `tertiary` to `<sp-button>` component [#9999](https://github.com/adobe/spectrum-web-components/pull/9999)
- **Fixed**: Fixed `<sp-theme>` theme compatibility issues [#10000](https://github.com/adobe/spectrum-web-components/pull/10000)
- **Added**: Added new variant `tertiary` to `<sp-button>` component [#9999](https://github.com/adobe/spectrum-web-components/pull/9999)
- **Fixed**: Fixed `<sp-theme>` theme compatibility issues [#10000](https://github.com/adobe/spectrum-web-components/pull/10000)
```

For our guidelines on writing changesets, see [our writing changesets guide](https://opensource.adobe.com/spectrum-web-components/guides/writing-changesets/).
Expand All @@ -61,6 +68,6 @@ We have a quick list of common questions to get you started engaging with this p

## Additional Resources

- [Changesets Documentation](https://github.com/changesets/changesets)
- [Common Questions](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
- [Detailed Release Process](https://github.com/changesets/changesets/blob/main/docs/detailed-explanation.md)
- [Changesets Documentation](https://github.com/changesets/changesets)
- [Common Questions](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
- [Detailed Release Process](https://github.com/changesets/changesets/blob/main/docs/detailed-explanation.md)
2 changes: 1 addition & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"commit": false,
"fixed": [["@spectrum-web-components/*"]],
"linked": [],
"linked": [["@swc/components", "@swc/core"]],
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
Expand Down
Loading
Loading