chore: keep the publish credential away from the code it publishes - #21
Merged
Conversation
The publish job held an OIDC id-token while it installed dependencies and ran tests, so any postinstall in either tree could mint the credential npm exchanges for a publish token. The job now splits: a build job runs the release gates, the install, the tests, and packs the tarball holding no credential, and the publish job holds the id-token alone beside that tarball. A tag-on-main gate is what the approval now rests on, spelled refs/remotes/origin/main because git prefers a tag of that name over the remote-tracking ref. The release-notes composer also stops printing the origin URL when it refuses a non-GitHub remote, which can carry a credential.
There was a problem hiding this comment.
Pull request overview
This PR hardens the tag-triggered npm publish workflow by separating build/test/pack from the credentialed publish step, reducing exposure of OIDC credentials to any package lifecycle scripts. It also updates release documentation and avoids leaking potentially credential-bearing origin URLs in release tooling errors.
Changes:
- Split
.github/workflows/publish.ymlinto an uncredentialedbuildjob (gates, install, test, pack) and a credentialedpublishjob (artifact publish only). - Add a git ancestry gate to ensure the pushed tag’s commit is on
mainbefore approval/publish proceeds. - Update release docs and suppress printing the origin remote URL in
scripts/release-notes.sherror output.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
scripts/release-notes.sh |
Stops echoing the full origin URL when rejecting non-GitHub remotes to avoid credential leakage. |
RELEASING.md |
Documents the new build+publish split, approval expectations, and OIDC trusted publishing behavior. |
.github/workflows/publish.yml |
Implements the split workflow, tag-on-main gate, tarball artifact handoff, and credential-minimized publishing. |
Suppressed comments (1)
.github/workflows/publish.yml:86
actions/download-artifactuses the GitHub Actions API and typically requiresactions: read. With job-level permissions set to onlyid-token: write, artifact download can fail due to missingactionspermission. Consider granting the minimumactions: readhere (and keepcontentsunset if not needed).
permissions:
id-token: write
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
Why
The publish job held an OIDC id-token while it installed dependencies and ran the package lifecycle scripts, so a postinstall anywhere in either tree could mint the credential npm exchanges for a publish token. The workflow now splits: the build job runs the release gates, the install, the tests, and packs the tarball while holding no credential, and the publish job holds the id-token alone beside that prebuilt tarball, with no checkout and no dependency install.
The approval now rests on something mechanical. A build gate fails any tag whose commit is not an ancestor of main, so a green run is what the approver confirms. The gate names refs/remotes/origin/main in full, because a full-history checkout also fetches tags and git resolves a bare origin/main as refs/tags/origin/main first, which a pushed tag of that name could exploit. It runs directly after checkout, before the toolchain steps that execute configuration from the tagged commit. Every action is pinned by commit sha, and the npm CLI in the credentialed job is pinned exact and installed with --ignore-scripts.
scripts/release-notes.sh also stops printing the origin remote when it refuses a non-GitHub URL, which can carry credentials.
Validation
The workflows parse, and the mechanical checks hold: the build job carries no id-token and no environment; the publish job carries needs, the environment, id-token: write alone, and a tarball publish with --provenance --ignore-scripts; every uses line is a 40-hex sha with a version comment. The release-notes suite passes with its count unchanged from main. The split path itself runs at the next tag; the rendered workflow is the evidence until then.