Skip to content

docs(skill): refine release-manager guidance from the v1.5.0 and v1.5.1 releases - #3348

Open
fengmk2 wants to merge 2 commits into
mainfrom
docs/release-manager-v1.5.0-learnings
Open

fengmk2 wants to merge 2 commits into
mainfrom
docs/release-manager-v1.5.0-learnings

Conversation

@fengmk2

@fengmk2 fengmk2 commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

Fold the durable lessons from the v1.5.0 and v1.5.1 releases into the release-manager skill.

From v1.5.0

  • Homebrew (step 2): before merging, run test-homebrew.yml by hand on the release branch to install the release head through a disposable tap on macOS ARM64 and Linux. A sandboxed agent cannot run brew install, because Homebrew refuses an inherited sandbox that can write to its prefix.
  • Changelog credits (step 3): check commit authors for every changelog PR, not only bot or carried-over PRs, and credit maintainers whose commits change code. Test-, snapshot-, and doc-only touch-ups do not earn credit.
  • Changelog style (step 3): do not name a few upgraded tools in the opening sentence when several moved. Put commands in a code block under the list item, without a blank line before the fence, because that blank line makes the whole list loose on GitHub.
  • Fork smoke PRs (step 4): keep descriptions, comments, and commit messages free of references to vite-plus PRs or issues. GitHub keeps each cross-reference on the vite-plus timeline even after the text is edited.
  • Preview rebuilds (step 4): relabeling to rebuild the preview also restarts the PR's CI, and the cancelled run shows a failed done check until the new run finishes.
  • Triage (step 4): add stale pnpm metadata cached under the bridge registry, forks whose Actions GitHub disabled without the setting showing it, and AGENTS.md checks that see the preview docs origin.
  • Carried-over fixes (step 4): drop fixes that upstream made obsolete, redo restored dependency pins with the bundled versions, and reinstall after re-applying package.json changes so the lockfile matches.
  • Release notes (step 8): add a Homebrew block to the Installation section once the release's formula PR is merged.
  • Upgrade check (step 8): replace an awk snippet whose positional fields the skill loader replaced with the invocation arguments, and record in step 9 that the skill must not contain positional references.

From v1.5.1

  • Security entries (step 3): a security fix in vite-plus's own code goes first in Fixes & Enhancements with a Security: label, not in Features. Security fixes from upstream dependency upgrades still lead Features.
  • Draft advisories (step 3): match the repository's draft advisories to their fix PRs. Until an advisory is published, describe the fix by its behavior only, and keep the reporter's co-author credit. After publication, add the severity and the advisory link to the release notes and the announcement, and link the repository advisory page until the global advisory database lists it.
  • Cancelled checks (step 5): each label added to the release PR starts a new set of runs and cancels the set in progress. A cancelled matrix job can show as a failed check with an unexpanded name, so confirm a later run of the same workflow passed on the same head.
  • Native-addon publish (step 7): the native-addon step can time out while npm processes one platform package. No vite-plus or core version is published before that step passes. Wait until npm serves the package, then use "Re-run failed jobs" and confirm the skip line for each platform package.
  • Release notes validation (step 8): after the merge, generate-notes also lists the release PR itself, which is not a changelog entry.
  • Local Homebrew check (step 8): keep the isolated prefix out of Homebrew's temporary directory. When the agent sandbox or a TLS-inspecting proxy blocks the local check, report the Published Homebrew CI checks as the evidence and give the release manager the local command.
  • X replies (step 8): read contributors' X handles from their GitHub profiles, and use the GitHub profile URL when no X account is listed.

🤖 Generated with Claude Code

- Test Homebrew installation before merging with a manual test-homebrew.yml
  run, and note that sandboxed agents cannot run brew install.
- Check commit authors for every changelog PR and credit substantive
  maintainer commits.
- Keep opening sentences free of a partial list of upgraded tools, and put
  commands in code blocks without the blank line that makes lists loose.
- Keep fork smoke PRs free of vite-plus PR and issue references.
- Note that relabeling for a preview rebuild restarts and cancels PR CI.
- Add triage notes for stale pnpm bridge metadata, forks with Actions
  disabled, and the preview docs origin in AGENTS.md checks.
- Drop obsolete carried-over fixes and refresh lockfiles after re-applying
  package.json changes.
- Add the Homebrew block to the release notes Installation section.
- Replace an awk snippet whose positional fields the skill loader replaced
  with invocation arguments, and record that constraint.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview URL: https://docs-release-manager-v1-5-0-learnings-viteplus-dev.voidzero-docs.workers.dev (commit dce4307)

This URL reflects your latest Preview deployment

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://42411251-viteplus-dev.voidzero-docs.workers.dev dce4307 2026-11-10T03:11:36.197Z Visit the dashboard ↗
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://dc7ca43d-viteplus-dev.voidzero-docs.workers.dev 5614cb6 2026-11-04T05:44:29.441Z Visit the dashboard ↗

@fengmk2
fengmk2 marked this pull request as ready for review November 4, 2026 07:01
@fengmk2 fengmk2 self-assigned this Nov 4, 2026
@fengmk2
fengmk2 requested a review from wan9chi November 4, 2026 07:01
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@fengmk2 fengmk2 changed the title docs(skill): refine release-manager guidance from the v1.5.0 release docs(skill): refine release-manager guidance from the v1.5.0 and v1.5.1 releases Nov 10, 2026
@fengmk2
fengmk2 requested review from wan9chi and removed request for wan9chi November 10, 2026 03:10

This branch has not been deployed

No deployments
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.

1 participant