Release: the publish job's id-token: write is reachable by npm install scripts; split build from publish

Open
#301 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
github-actions, typescript

Research direction

Start with .github/workflows/release-cli.yml and compare the release flow with the credential handling in #282. Trace the publish steps and downstream jobs, then check scripts/attach-release-provenance.mjs and how the rerun check uses gitHead. Done means the workflow separates build, publish, and release permissions, verifies the downloaded tarball, and preserves the provenance and release checks.

Written by the indexing model from the issue text.

Description

Design note, follow-up to #281 / #282.

Problem

In .github/workflows/release-cli.yml, the publish job has id-token: write (and contents: write) for the whole job. While a job has id-token: write, every step in it gets ACTIONS_ID_TOKEN_REQUEST_URL and ACTIONS_ID_TOKEN_REQUEST_TOKEN in its environment. Any code running in that job can use them to request a GitHub OIDC token for this workflow, and that token is what npm trusted publishing accepts for @diffci.com/diffci.

The same job then runs third-party code before it publishes:

  • npm ci --no-audit --fund=false in packages/diffci-cli, with install scripts enabled. That covers the dependencies' preinstall/install/postinstall scripts, and the prepare build of the @diffci.com/core git dependency together with its own dependencies.
  • npm install --global npm@11, which is an unpinned version range.
  • npm run typecheck, build, package:check, package:smoke, and then npm publish, which runs the package's prepack lifecycle.

A compromised dependency could therefore publish a version of @diffci.com/diffci that carries a valid provenance attestation for this repository. #282 keeps the contents: write token out of .git/config, but it cannot help with the OIDC credential: that one comes from the job's permissions, not the checkout.

Proposal: split the job
  1. build job (permissions: contents: read, no id-token). It holds every step that installs or runs code: tag check, npm ci, check-agent-packaging, typecheck, build, package:check, package:smoke. It then runs npm pack and uploads the tarball (and its sha512/integrity) with actions/upload-artifact.
  2. publish job (needs: build, permissions: id-token: write only, environment: optional). It does not run npm ci or any install or lifecycle scripts. It sets up Node and npm (ideally with a pinned npm version) and downloads the artifact. It checks the tarball against the recorded digest, then runs the existing "already published from this commit" check and npm publish <tarball> --access public --provenance --ignore-scripts.
  3. Release job(s) for the steps that need contents: write: wait for propagation, observer Action smoke, GitHub Release, provenance assets, action-v tag, verify-release. These run after publish without id-token: write. They can keep contents: write with persist-credentials: false as in #282.

The downstream jobs (publish-gitlab-component, publish-mcp-registry, notify-hosted-mcp) would need needs: updated to the new final job.

Things to check while doing it
  • gitHead: the existing re-run check compares the published gitHead with GITHUB_SHA. When publishing from a folder in a git checkout, npm fills gitHead in itself. That field needs confirming for npm publish <tarball>, or the check needs to be kept another way, for example by recording the commit in the artifact.
  • Provenance subject: the attestation names the tarball's sha512. scripts/attach-release-provenance.mjs already checks that subject against what npm serves, so it should keep passing unchanged.
  • Tarball contents: npm pack in the build job runs prepack (build:client) without the OIDC credential, so the tarball contents stay the same as today's npm publish.

Related: #281, #282.

Dominant language
TypeScript
Stars
0
Forks
4
Avg merge
18h 41m
Merged PRs (30d)
48

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DiffCI/core

All issues in DiffCI/core

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.