Release: the publish job's id-token: write is reachable by npm install scripts; split build from publish
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 42/100
- issue の種類
- リファクタリング
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- github-actions, typescript
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- TypeScript
- スター
- 0
- フォーク
- 4
- 平均マージ
- 18時間 41分
- マージ済み PR(30日)
- 48
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
DiffCI/core のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
Planner: splitParts regex is quadratic on a quote followed by many backticks, so the fuzz test fails at random対応中かも @FredApps が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
メンテナーはふだん 1 日以内に返信
-
Agent tools: changed_files lists only the new path of a renamed file対応中かも @FredApps が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信
-
adapter good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
agent-ready area: ui-server priority: p3 type: test
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
schlessera/brain-kit#4249 ·
メンテナーはふだん 1 日以内に返信
-
documentation tool triaged
難易度 2/5 1〜3時間 初心者へのやさしさ 73/100
can1357/oh-my-pi#19608 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
dependencies tech-debt
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
bcgov/nr-waste-plus#1549 ·
メンテナーはふだん 1 日以内に返信
-
enhancement good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
blixvip/solana-token-meta#17 ·
-
enhancement good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
blixvip/solana-tx-parse#18 ·