Skip to content

README.md

Latest commit

 

History

History
60 lines (46 loc) · 3.51 KB

README.md

File metadata and controls

60 lines (46 loc) · 3.51 KB
Raw

Changesets

Roomote uses Changesets as an authoring format only for a single product version. The canonical version is the root package.json field; workspace package versions are frozen and meaningless (packages are private and never published). pnpm run version (a small in-repo script, scripts/release/apply-version.mjs) folds pending changesets into the root CHANGELOG.md, bumps the root version by the highest pending level, and deletes the consumed files — changeset version itself is never run.

Adding a changeset (optional)

For user-visible or operator-visible changes that should show up in the changelog and influence the semver bump:

pnpm changeset

When prompted for packages, pick a single package — prefer @roomote/web. The frontmatter only carries the bump level (workspace package versions are frozen); the release script reads the highest level across all pending changesets and applies it to the single product version. Prefer one package line over a multi- package map so the file does not look like a package-level change inventory. Choose:

  • patch for bug fixes and small non-breaking changes
  • minor for new capabilities that stay backward compatible
  • major for breaking behavior changes

Commit the generated file under .changeset/ with the rest of the PR.

Chores, docs-only, and pure-internal refactors can skip a changeset; they ride along with the next release.

How a release ships

  1. Merge code to develop, including changesets with user-visible changes when practical. Pending changesets accumulate until a maintainer cuts a release.
  2. Use the changeset-release-pr skill to audit changes since the last release, fill any missing notes, and run pnpm run version. It opens one Release Roomote X.Y.Z PR against develop containing the root version bump, final CHANGELOG.md section, and consumed changeset deletions.
  3. Squash-merge that release PR. CI cuts a frozen release/vX.Y.Z branch at the version-bump commit and opens or refreshes a Promote PR (release/vX.Y.Z → main). Commits merged to develop afterward normally wait for the next release. Before promotion, maintainers may add changesets, run pnpm run version -- --amend, merge the amended notes to develop, and explicitly dispatch the Release workflow for that version. The refresh is fast-forward-only and refuses shipped, closed, divergent, newer-version, or pending-changeset states.
  4. Merge the Promote PR with a merge commit (not squash) into main to tag vX.Y.Z. GHCR builds the matching images, and the GitHub Release is created only after those images exist so releases/latest never points at a missing image set. The release/vX.Y.Z branch can be deleted after the merge.

If a maintainer explicitly replaces an unshipped candidate with a later version, run pnpm run version -- --supersede <patch|minor|major>. This retains the candidate's notes, consumes newer changesets, updates the root version, and replaces the existing changelog heading. Close the superseded Promote PR before promoting the replacement.

Branch rules (must match GitHub rulesets):

  • develop: squash-only merges for feature and release PRs.
  • main: merge-commit-only so promote PRs keep shared history with develop.

Maintainers: product tagging requires repository secret RELEASE_BOT_TOKEN (see .github/workflows/tag-release.yml). Contributor overview: CONTRIBUTING.md.