Skip to content

docs: add calver changeset rules to AGENTS.md - #4637

Open
vctrchu wants to merge 3 commits into
2026-10-rcfrom
vchu/agents-calver-docs
Open

docs: add calver changeset rules to AGENTS.md#4637
vctrchu wants to merge 3 commits into
2026-10-rcfrom
vchu/agents-calver-docs

Conversation

@vctrchu

@vctrchu vctrchu commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Docs-only follow-up to #4636.

Adds a Changesets and versioning section to AGENTS.md: packages here are calver-keyed (major.minor of the npm version is the Shopify API version), so breaking changes must ship as minor changesets — a major rolls the calendar year, produces a nonexistent API version, and breaks the tester's version check branch-wide. Also notes that pre-mode retains released changeset files, so version corrections must fix the changeset itself, not just package.json.

Assisted-By: devx/60256637-da58-4f80-9e3a-977e038d8a71
@vctrchu vctrchu self-assigned this Aug 18, 2026
Assisted-By: devx/60256637-da58-4f80-9e3a-977e038d8a71
Assisted-By: devx/60256637-da58-4f80-9e3a-977e038d8a71
@vctrchu
vctrchu requested a review from a team August 18, 2026 00:12
Comment thread AGENTS.md

- **Never mark a changeset `major`.** A major bump rolls the calendar year
(`2026.10.0` → `2027.0.0` → API version "2027-00", which doesn't exist),
breaks the tester's version check on every PR, and publishes an RC that is

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wondering if better to simplify and skip details other than it breaks things.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants