Skip to content

Latest commit

 

History

History
27 lines (21 loc) · 1.18 KB

RELEASING.md

File metadata and controls

27 lines (21 loc) · 1.18 KB
Raw

Releasing

Overview

This package is versioned and released using changesets. A changesets pull request with the title "chore: release" should be opened automatically and get updated automatically with the current list of pending changes since the previous release. Merging this PR will release those pending changes under the next appropriate version.

How

Each commit or pull request should include a changeset if it should (eventually) have an impact on the package version. To create one: run npx changeset, answer the questions, and commit the results. Changes that don't facilitate a version bump (i.e., "chores") don't necessarily need a changeset.

The flow:

  1. Checkout a new branch
  2. Make your changes
  3. Run npx changeset, answer the questions, commit the results
  4. Push your branch and open a pull request
  5. Once these changes are in the main branch, the changesets pull request will be updated automatically.
  6. When you're ready to release a new version, merge the changesets PR to main and the GitHub "Release" workflow will publish the package to npm and commit the updated CHANGELOG.md file back to the repository.