| name | changesets |
| description | Use when a pull request changes a package's public API. Covers affected packages, semantic version impact, file format, and user-focused release notes. |
Changesets
This repository uses Changesets to
version packages and generate changelogs. Add a changeset whenever a pull
request changes the public API of a published package.
A changeset records:
- Every published package affected by the public API change
- The semantic version impact (
patch, minor, or major) for each package
- A concise description of the change for users of the affected packages
When a changeset is required
Add a changeset for consumer-facing changes such as:
- Adding, removing, or renaming an icon
- Changing an icon's rendered appearance or behavior
- Adding, removing, or changing an export
- Changing public JavaScript, React, CSS, or TypeScript APIs
- Fixing behavior that users experience through a package's public API
Changes that do not affect a published package's public API, such as
documentation, tests, internal refactors, or CI configuration, do not need a
changeset. Add the skip changeset label to those pull requests.
Identify affected packages
Review the change from the perspective of users of each published package.
Include every package whose shipped public API or output changes:
@primer/octicons@primer/octicons-react@primer/styled-octicons
Do not select a package only because its internal source or build process
changed. Select it when users of that package will observe the change.
Choose the version impact
