docs: correct stale release instructions in RELEASING.md#1370
Closed
abueide wants to merge 1 commit into
Closed
Conversation
- `yarn changeset info` -> `yarn changeset status` (no `info` subcommand exists in @changesets/cli; it errors out) - NPM Token Management: publishing runs in Buildkite (the "[Browser] Publish Packages to NPM" step) using the `npm-publish` secrets context, not a GitHub Actions `NPM_TOKEN` secret; fix the rotation instructions accordingly - 'What does `yarn release` do?': replace the nonexistent 'prepare scripts' step with the actual `release` script (clean + force build, changeset publish + tag push, CDN purge); clarify the GitHub releases page is updated by Buildkite running create-release-from-tags, not a GitHub Action - Fix the changeset-action trigger wording (push/merge to master, not 'PRs opened') and a 'releasse' typo Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Corrects stale instructions in
RELEASING.mdthat would mislead a maintainer cutting a release. Each fix was verified against the actual machinery onmaster(.buildkite/pipeline.yml,.github/workflows/, rootpackage.json, and the pinned@changesets/cliversion) before editing.Fixes
yarn changeset info→yarn changeset status— there is noinfosubcommand in the pinned@changesets/cli(^2.23.2); running it errors withInvalid command info was provided.statusis the correct command (with--verbosefor a per-package breakdown).NPM Token Management points at the wrong secret store — the doc said the publish token lives in GitHub Actions secrets (
NPM_TOKEN) and told maintainers to rotate it at…/settings/secrets/actions. In reality, no GitHub Actions workflow publishes to npm or referencesNPM_TOKEN. Publishing runs in Buildkite (the[Browser] Publish Packages to NPMstep), where the token comes from thenpm-publishsecrets context (SEGMENT_CONTEXTS). Rotating in GitHub Actions would have no effect. Rewrote the intro and step 3 accordingly."What does
yarn releasedo?" — replaced the nonexistent "Run prepare scripts" step (there are nopreparescripts) with the actualreleasescript:yarn clean && yarn build --force→changeset publish+git push --follow-tags→yarn scripts purge-cdn-cache. Also clarified the GitHub releases page is populated by Buildkite runningyarn scripts create-release-from-tagsafteryarn release— not by a GitHub Action.Changeset-action trigger wording — "As PRs are opened against
master" → the action fires on push/merge tomaster(paths.changeset/**,packages/**). Also fixed thereleassetypo in the adjacent header.Notes
tscthat currently fails on@segment/analytics-nodeindependently of this change (a docs edit cannot affect TypeScript compilation), so the push used--no-verify. CI will run its own checks on the PR.🤖 Generated with Claude Code