Skip to content

docs(release): quote the three-step version script in every comment - #1030

Closed
auxesis wants to merge 2 commits into
mainfrom
docs/release-version-comment
Closed

auxesis wants to merge 2 commits into
mainfrom
docs/release-version-comment

Conversation

@auxesis

@auxesis auxesis commented Oct 3, 2026 •

Copy link
Copy Markdown
Contributor

This pull request corrects three comments that quote the root version script. It changes no behaviour.

The comments quoted the old version script

Three comments quoted the root version script as changeset version && node scripts/sync-lockstep-versions.mjs. Pull request #1028 added a step between the two, so the script is now changeset version && node scripts/sync-skill-pins.mjs && node scripts/sync-lockstep-versions.mjs. Each comment now quotes it as it is. This is follow-up work for Linear issue CIP-4285.

  • .github/workflows/release.yml: the comment above the mise step in the release job. It now also says that the last script is the one that calls mise.
  • scripts/sync-lockstep-versions.mjs: the comment on the main guard.
  • scripts/__tests__/script-main-guards.test.mjs: the header of the test.

The last two comments keep their point. The && chain reads a script that exits 0 without doing anything as a completed version bump.

Checks

  • actionlint 1.7.7 with shellcheck 0.11.0 on release.yml: no findings.
  • pnpm test:scripts: 67 files pass.
  • pnpm run code:check: no errors.

Linked issues

Part of #1044.

🤖 Generated with Claude Code

https://claude.ai/code/session_01PaY5xYydZUWhv8Nex9Sw8a

The comment above the mise step in the release job still quoted the root
`version` script as `changeset version && node
scripts/sync-lockstep-versions.mjs`. Since #1028 it also runs
scripts/sync-skill-pins.mjs between the two. Quote it as it is.

Refs: CIP-4285

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PaY5xYydZUWhv8Nex9Sw8a
@auxesis
auxesis requested a review from a team as a code owner October 3, 2026 00:39
@changeset-bot

changeset-bot Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 918303c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

The main-guard comment in scripts/sync-lockstep-versions.mjs and the
header of scripts/__tests__/script-main-guards.test.mjs both quoted the
root `version` script as `changeset version && node
scripts/sync-lockstep-versions.mjs`. Since #1028 it also runs
scripts/sync-skill-pins.mjs between the two. Quote it as it is. Both
comments keep their point: the `&&` chain reads a silent exit 0 as a
completed bump.

Refs: CIP-4285

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PaY5xYydZUWhv8Nex9Sw8a
@auxesis auxesis changed the title docs(release): name all three steps of the version script in release.yml docs(release): quote the three-step version script in every comment Oct 3, 2026

@freshtonic freshtonic left a comment

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.

Approved. The three comments now quote the root version script as it is on this head: changeset version && node scripts/sync-skill-pins.mjs && node scripts/sync-lockstep-versions.mjs (package.json:38). Each comment keeps its original argument. The added words "that last script" in release.yml make it clear that sync-lockstep-versions.mjs calls mise, not sync-skill-pins.mjs.

Checks I did:

  • No test reads the text of these comments. workflow-mise-setup.test.mjs already writes the chain as changeset version && … && node scripts/sync-lockstep-versions.mjs, so it was correct before and after this change.
  • No other live comment quotes the old two-step script. The only old quotes that remain are in docs/plans/2026-08-13-eql-monorepo-absorption.md. That is a historical plan, so it is correct to keep it as it is.
  • No changeset is necessary. The change touches only comments in a workflow, a script, and a test, and none of these ship in a package.

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