docs(release): explain package provenance - #361
Conversation
Signed-off-by: Mr-Neutr0n <harikp2002@gmail.com>
mldangelo-oai
left a comment
There was a problem hiding this comment.
Thanks for addressing #234. The tag-to-commit-to-bundled-tree mapping is useful, and the published 0.1.5 bundle matches its tagged source. Before merging, please distinguish signed provenance verification from registry metadata inspection and document the supported historical releases that do not expose gitHead.
| metadata: | ||
|
|
||
| ```bash | ||
| npm view "@openai/codex-security@${VERSION}" version gitHead dist.integrity |
There was a problem hiding this comment.
npm view only reports registry metadata; it does not verify the package bytes or a signed provenance attestation. gitHead is package metadata and dist.integrity is a tarball digest, so this recipe does not establish that the npm artifact was produced from the tagged commit and bundled tree. The release workflow additionally checks the archive and runs npm audit signatures --include-attestations, then binds the attestation to the expected repository, commit, and release run. Please document comparable verification, or explicitly describe this command as metadata inspection rather than provenance verification.
| ``` | ||
|
|
||
| The first two values form the immutable release-to-bundle mapping. The npm | ||
| registry also records the published package's release commit and integrity |
There was a problem hiding this comment.
This is not true for every published release: 0.1.0 and 0.1.1 both omit gitHead from their published package manifests. I checked the release archives; 0.1.5 does contain the expected commit. verifyGitHubPublishedRelease explicitly permits those two historical versions only after recovering the commit from verified signed provenance. Please qualify gitHead as available starting with 0.1.2 and document the attestation-based fallback for 0.1.0 and 0.1.1.
Signed-off-by: Mr-Neutr0n <harikp2002@gmail.com>
|
Addressed the review: clarified that npm registry metadata is inspection-only, documented signed SLSA verification with npm audit signatures, and named 0.1.0/0.1.1 as the only legacy releases that may omit gitHead. Mr-Neutr0n@29e0bed |
Summary
gitHeadand integrity metadata, and why external catalog versions must come from runtime release metadataFixes #234.
Verification
pnpm run formatpasses