Skip to content

docs(release): align release checklist with the #1119 auto-publish flow#1137

Merged
Astro-Han merged 2 commits into
devfrom
claude/release-checklist-auto-publish-note
Jun 3, 2026
Merged

docs(release): align release checklist with the #1119 auto-publish flow#1137
Astro-Han merged 2 commits into
devfrom
claude/release-checklist-auto-publish-note

Conversation

@Astro-Han
Copy link
Copy Markdown
Owner

@Astro-Han Astro-Han commented Jun 3, 2026

Summary

Bring .github/RELEASE_CHECKLIST.md in line with the auto-publish flow merged in PR #1119. A Codex audit of the checklist against the actual pipeline (build.yml + the release scripts) found the manual publish steps now read as required/safe when they bypass the auto-publisher's guards. This rewrites Steps 3–5:

  • Step 4 — a prod release publishes itself; document how to read the auto-publish outcome (published / wait / fail) and what to do for each. Manual gh release edit is demoted to a clearly-marked last resort that pins target_commitish and is never used for a partial draft or to mark a non-prod build latest.
  • Step 5 — correct the R2 trigger: the normal path is the auto-publisher's explicit workflow_dispatch (a GITHUB_TOKEN publish emits no release: published); the webhook fires only on a manual personal-credential publish.
  • Step 3 — note all three final targets must come from one build commit (mac finalize uses source_sha, win full uses dev HEAD) or auto-publish fails closed; fix the stale source_workflow_ref example.

Docs only — no code change. Follow-up to PR #1119; no separate issue.

Why

PR #1119 made prod releases publish automatically with a single-source guard (per-target provenance markers, content anchor, seal/re-read). The checklist still presented manual gh release edit --draft=false --latest as a normal/fallback step. Codex flagged two [P1]s: (1) the manual command bypasses every guard, and the "use it for a partial build / non-prod" framing invites publishing an incomplete or non-stable release as latest; (2) when auto-publish has failed closed (mixed-source / metadata drift / missing marker), following the manual step force-publishes exactly the bad state the guard caught — and it didn't pin target_commitish. This rewrite makes the runbook match what the code actually does and removes the foot-gun.

Related Issue

None — documentation follow-up to PR #1119.

Human Review Status

Pending

Review Focus

Accuracy of the rewritten steps against the merged pipeline: that auto-publish fires for the Step 3 build commands, publishes pinned to the build commit + latest, and dispatches the mirror; that the "wait / fail → do not hand-publish" guidance matches publish-when-complete.ts; and that the same-commit requirement (mac source_sha vs win github.sha) is stated correctly.

Risk Notes

Documentation only — no code, workflow, dependency, permission, or behavior change. The change removes a dangerous instruction (manual publish that bypasses the #1119 guards) and reframes it as a guarded last resort. The two gh surfaces referenced were verified to exist (gh release edit --target, gh release view --json targetCommitish). No visible app UI or copy changed (UI checklist item left unticked for that reason).

How To Verify

Audited each step against build.yml + publish-when-complete.ts / finalize-latest-yml.ts /
verify-release.ts / mirror-release-to-r2.{yml,ts} (Codex, read-only) — 2 P1 + 3 P2 found, all
addressed in this rewrite.
gh CLI surfaces used in the doc confirmed present:
  gh release edit --help    -> --target <branch/SHA> exists
  gh release view --json targetCommitish -> field accepted (reached "release not found")
git diff dev...HEAD: only .github/RELEASE_CHECKLIST.md, Steps 3-5; manual path kept as last resort.

Screenshots or Recordings

N/A — repository documentation only.

Checklist

How to use this checklist:

  • Tick a box by replacing [ ] with [x]. Do not edit, add, or remove items.
  • The bot-applied label items can only be honestly ticked AFTER the PR is opened and the labeler / priority-triage bots have run — return to the PR description and tick them then.
  • Most items are required. The few that are conditional are explicitly marked (conditional); for those, leave unticked if they truly do not apply and explain why in Risk Notes. All other items must be ticked before requesting human review.
  • Type label — this PR carries exactly one of bug, enhancement, task, documentation. Type labels are author-added; the labeler bot does NOT assign them. Add the label in the GitHub UI, then tick this.
  • Routing labels — this PR carries at least one of app, ui, platform, harness, ci. The labeler bot assigns these on PR open based on changed paths. Confirm the bot's choice (or override if wrong), then tick this.
  • Priority label — this PR carries exactly one of P0, P1, P2, P3. The priority-triage bot suggests one on PR open. Confirm or override, then tick this.
  • Human Review Status above is set to Pending, Approved by @<reviewer>, or Not required: <reason> (default is Pending; "not required" is restricted to bot-authored low-risk PRs).
  • I linked the related issue, or stated in Summary why there is no issue.
  • I described the review focus and any meaningful risks.
  • I replaced the example block in How To Verify with the real verification steps and the key result for each.
  • I did not introduce unrelated refactors, dependencies, generated files, or file changes beyond the stated scope.
  • (conditional) I manually checked visible UI or copy changes when needed, with screenshots or recordings. Leave unticked only if no visible UI or copy changed.
  • (conditional) I considered macOS and Windows impact for platform, packaging, updater, signing, paths, shell, or permissions changes. Leave unticked only if no platform/packaging surface was touched.
  • (conditional) I called out docs, release notes, dependencies, permissions, credentials, deletion behavior, generated content, or local file changes when relevant. Leave unticked only if none of those surfaces was touched.
  • I reviewed the final diff for unrelated changes and suspicious dependency changes.
  • I am targeting dev, and my PR title and commit messages use Conventional Commits in English.

…lback

PR #1119 made the prod build pipeline publish the draft and dispatch the R2
mirror automatically once all targets land, so the checklist's manual Step 4/5
now apply only as a verification fallback (non-prod channel or a partial build).
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 3, 2026

Warning

Rate limit exceeded

@Astro-Han has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 4 minutes and 24 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 88b62614-06b5-46d0-a2df-3364a7fef895

📥 Commits

Reviewing files that changed from the base of the PR and between 2081b37 and 27a3f2e.

📒 Files selected for processing (1)
  • .github/RELEASE_CHECKLIST.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/release-checklist-auto-publish-note

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Astro-Han Astro-Han added documentation Improvements or additions to documentation ci Continuous integration / GitHub Actions P3 Low priority labels Jun 3, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the release checklist documentation (.github/RELEASE_CHECKLIST.md) to clarify that the production release auto-publishes, making the manual publishing steps a verification fallback. There are no review comments to address.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Suggested priority: P3 (only low-risk paths changed (.github/RELEASE_CHECKLIST.md)).

P1/P0 are reserved for maintainer confirmation. Please relabel manually if this is a release blocker, security issue, data-loss risk, or updater/runtime failure.

A Codex audit of the checklist against the merged #1119 pipeline found the
earlier "manual steps are a fallback" framing was a foot-gun: the manual
gh release edit --draft=false bypasses every guard the auto-publisher adds
(completeness, single-source markers, metadata hash anchor, seal/re-read), so
following it when auto-publish has failed-closed force-publishes exactly the bad
state the guard caught.

- Step 4: a prod release publishes itself; describe how to read the auto-publish
  outcome (published / wait / fail) and what to do for each. Demote manual
  publish to a clearly-marked last resort that pins target_commitish and is
  never used for a partial draft or to mark a non-prod build latest.
- Step 5: correct the R2 trigger — the normal path is the auto-publisher's
  explicit workflow_dispatch (a GITHUB_TOKEN publish emits no release:published);
  the webhook only fires on a manual personal-credential publish.
- Step 3: note all three final targets must come from one build commit (mac
  finalize uses source_sha, win full uses dev HEAD) or auto-publish fails closed;
  fix the stale source_workflow_ref example (now a workflow-snapshot tag).
@Astro-Han Astro-Han changed the title docs(release): note prod auto-publishes; manual steps are fallback docs(release): align release checklist with the #1119 auto-publish flow Jun 3, 2026
@Astro-Han Astro-Han merged commit 478470e into dev Jun 3, 2026
35 checks passed
@Astro-Han Astro-Han deleted the claude/release-checklist-auto-publish-note branch June 3, 2026 12:20
Astro-Han added a commit that referenced this pull request Jun 3, 2026
Restructure the right-side Status panel from 2 sections (Progress + Sources) into 4 (Progress -> Workspace/Git -> Changed files/Artifact -> Sources), fold the standalone Files tab into the panel as a compact changed-files list, and move the titlebar worktree badge into the Git section.

Change boundary (packages/app, packages/ui):
- Status panel: new Git section (diff stats -> Review, branch row, worktree indicator with tooltip + open-directory) and Artifact section (changed files with hover/focus-visible open + reveal); Git section hidden outside a git repo. Data from sync.data.vcs (branch), sessionInfo().executionContext.activeWorktree (worktree), aggregateFiles(turn_change_aggregate) (diff stats).
- Files tab removed from RightPanelStaticTab / RIGHT_PANEL_TAB_META / command palette / keybind; legacy persisted "files" coerced to "status" via coerceLegacySidePanelTab + migrateLegacyRightPanelTab.
- Titlebar PawworkWorktreeBadge removed (worktree info now lives in the panel Git section).
- New `changes` icon registered (packages/ui).

Verification:
- typecheck clean; full app unit suite 1753 pass / 0 fail.
- Visual: status-summary-panel snap (4 sections + rest->hover open/reveal) plus a dev:desktop walk in the real Electron host (dark theme, zh locale, live sidecar) - Git section populated from real VCS (+N/-N, branch main), Artifact section listing a real session file (sample-test.md, +76).
- Codex adversarial review P1 findings fixed; 5 review threads resolved.

Brought current with dev: one conflict in context/layout.tsx - dev had extracted the inline layout helpers into context/layout-state.ts / layout-projects.ts (#1056 slice work). Took dev's refactored layout.tsx and ported this branch's defaultSidePanelTab `| "files"` widening into layout-state.ts. Final state 0 behind dev; also merged #1135/#1136/#1137/#1139 cleanly (no file overlap).

Deferred: dev:desktop worktree-indicator tooltip + non-git-hide are state-conditional and were not exercised live (hover open/reveal covered by the snap). session-side-panel.test.tsx isolation failure is the pre-existing mock.module warmup flake (its @/context/command mock omits matchKeybind/parseKeybind that terminal.tsx imports transitively); green in the full suite, tracked under the #1084 mock.module cleanup.

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

Labels

ci Continuous integration / GitHub Actions documentation Improvements or additions to documentation P3 Low priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant