diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 8706177dd4..ce0f20b6f8 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -299,6 +299,9 @@ jobs: needs: [pack] runs-on: ubuntu-latest timeout-minutes: 30 + # npm-publish requires a maintainer's approval. That approval is the only + # review a prerelease tag gets, because prerelease branches have no PR review. + # npm's trusted publishers name this environment, so every trigger uses it. environment: npm-publish # This job holds the release credentials, so it runs no code from the # release commit: no install, no build, no repo scripts. It checks the diff --git a/docs/contributing/release-channels.mdx b/docs/contributing/release-channels.mdx index decd644202..765df3ef21 100644 --- a/docs/contributing/release-channels.mdx +++ b/docs/contributing/release-channels.mdx @@ -32,7 +32,7 @@ On the first run, `release:prepare` drafts missing changelog artifacts and exits See [Changelog process](/contributing/changelog-process) for the full workflow. For stable releases, `bun run set-version ` still enforces this checkpoint when maintainers run the lower-level release command directly. -Push the release branch without its local tag, open a PR to `main`, and merge it after approval and CI. The publish workflow checks out the exact PR merge SHA, verifies it before publishing, creates the stable tag at that commit, publishes npm packages, and creates the GitHub release. +Push the release branch without its local tag, open a PR to `main`, and merge it after approval and CI. The publish workflow checks out the exact PR merge SHA, verifies it before publishing, creates the stable tag at that commit, publishes npm packages, and creates the GitHub release. Before it publishes, the run waits for a maintainer to approve it in the `npm-publish` environment. If that workflow needs recovery, rerun its original merged-PR event. Stable tag pushes and manual dispatches do not publish, so recovery cannot select a different commit. @@ -50,6 +50,8 @@ git push origin next git push origin v0.4.25-alpha.1 ``` +The tag push starts the publish workflow. It builds and packs the release, then waits for approval in the `npm-publish` environment. A maintainer other than the person who pushed the tag approves the run on the workflow page, and only then is anything published. A prerelease branch has no PR review, so this approval is its review. + Consumers can install alpha builds explicitly: ```bash @@ -65,6 +67,7 @@ The publish workflow validates release channel boundaries before publishing: - Prerelease versions must publish with the prerelease dist-tag, such as `alpha`. - Stable releases must come from a merged, reviewed `release/vX.Y.Z` PR. - Prerelease tags must be reachable from a prerelease branch. +- Every publish, stable or prerelease, waits for a maintainer other than the one who started it to approve the run in the `npm-publish` environment. - Merged `release/vX.Y.Z` PRs publish stable releases only. - Every publish job verifies that its checkout matches the immutable event SHA. - Builds, lifecycle scripts and `npm pack` run in a job with a read-only token and no secrets. diff --git a/scripts/publish-workflow.test.mjs b/scripts/publish-workflow.test.mjs index d52ac55c6d..a9e32a354a 100644 --- a/scripts/publish-workflow.test.mjs +++ b/scripts/publish-workflow.test.mjs @@ -483,3 +483,12 @@ test("publishing skips only identical uploads and fails on a version it did not assert.match(rerun.stdout, /::warning::/); assert.doesNotMatch(rerun.calls, /npm publish/); }); + +test("every publish runs in the approval-gated npm-publish environment", () => { + assert.equal(publish.environment, "npm-publish"); + const jobsWithEnvironment = Object.entries(config.jobs).filter(([, job]) => job.environment); + assert.deepEqual( + jobsWithEnvironment.map(([name]) => name), + ["publish"], + ); +});