Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 1.51 KB

File metadata and controls

60 lines (40 loc) · 1.51 KB

Version management with Changesets

About

We use Changesets to manage versioning and changelogs for various packages in this monorepo.

When to skip a changeset

Pull request titles that start with chore: can be merged without changesets.

These must contain changes with no tangible effect on the product. Otherwise, changeset is always required.

Example: chore: fix typo in code comment.

Typical workflow

  1. Commit some changes to a local branch.
  2. Run pnpm changeset.
  3. Select packages to update with <SPACE>.
  4. The changeset file will be auto-committed.
  5. Open a pull request.

You can include multiple changesets in a single pull request if each affected package contains distinct changes.

Conventions

Use capital letters and proper grammar in your changelogs. Omit the qualifier prefix.

---
dashboard: patch
---

fix: prevents double submit on upgrade button

---
dashboard: patch
---

Prevent double submit on upgrade button <feel free to elaborate if it is warranted. you have room to breath here.>

Release flow

Over time, several PRs will be merged and changesets will build up on main. There will also be a "release" pull request that is automatically created by the changeset action. Merging this PR to main constitutes cutting a release which currently adds git tags and pushes them to remote repository.