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

未關閉
#301 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
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=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.

主要語言
TypeScript
星號
0
分支
4
平均合併
18 小時 41 分鐘
30 天內合併 PR
48

環境準備

在 Codespaces 中開啟

在瀏覽器裡用你自己的 GitHub 帳號啟動這個專案的開發容器。

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

DiffCI/core 的其他 Issue

查看 DiffCI/core 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。