Release: the publish job's id-token: write is reachable by npm install scripts; split build from publish
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=falseinpackages/diffci-cli, with install scripts enabled. That covers the dependencies'preinstall/install/postinstallscripts, and thepreparebuild of the@diffci.com/coregit 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 thennpm publish, which runs the package'sprepacklifecycle.
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
buildjob (permissions: contents: read, noid-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 runsnpm packand uploads the tarball (and its sha512/integrity) withactions/upload-artifact.publishjob (needs: build,permissions: id-token: writeonly,environment:optional). It does not runnpm cior 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 andnpm publish <tarball> --access public --provenance --ignore-scripts.- Release job(s) for the steps that need
contents: write: wait for propagation, observer Action smoke, GitHub Release, provenance assets,action-vtag,verify-release. These run afterpublishwithoutid-token: write. They can keepcontents: writewithpersist-credentials: falseas 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
gitHeadwithGITHUB_SHA. When publishing from a folder in a git checkout, npm fillsgitHeadin itself. That field needs confirming fornpm 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.mjsalready checks that subject against what npm serves, so it should keep passing unchanged. - Tarball contents:
npm packin the build job runsprepack(build:client) without the OIDC credential, so the tarball contents stay the same as today'snpm publish.
Related: #281, #282.
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 4
- Avg merge
- 18h 41m
- Merged PRs (30d)
- 48
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from DiffCI/core
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Planner: splitParts regex is quadratic on a quote followed by many backticks, so the fuzz test fails at randomPossibly taken @FredApps claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
Agent tools: changed_files lists only the new path of a renamed filePossibly taken @FredApps claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
adapter good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
Similar issues
-
agent-ready area: ui-server priority: p3 type: test
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
schlessera/brain-kit#4249 ·
Maintainers usually reply within 1 day
-
documentation tool triaged
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
can1357/oh-my-pi#19608 · 2 comments ·
Maintainers usually reply within 1 day
-
dependencies tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
bcgov/nr-waste-plus#1549 ·
Maintainers usually reply within 1 day
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
blixvip/solana-token-meta#17 ·
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
blixvip/solana-tx-parse#18 ·