Skip to content

Commit cfda119

Browse files
committed
docs(changelog): Describe the npm contract as first-release content
The project has never been released, so the [Unreleased] section may not carry Changed or Removed categories, which presuppose previously released behavior. Fold the contract finalization into the Added section as the record the first release ships, revise the runner-image entry in place for the final ADR 0111/0112 annotation set, and drop the release-tag/provenance-sidecar removal entry: those inputs never shipped, so their absence is invisible to every user. Related #143 Signed-off-by: Yunseo Kim <[email protected]>
1 parent ce27945 commit cfda119

1 file changed

Lines changed: 20 additions & 33 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 20 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -123,12 +123,27 @@ Era five-digit years (e.g., `## [0.1.0] - 12026-06-13`).
123123
- Added the digest-verified build-stage Node.js runtime as a closed `node-runtime`
124124
`resolvedDependencies` descriptor in JS/TS npm provenance (ADR 0099), with the exact embedded
125125
`linux-x64` tarball URL and SHA-256 plus `builder-pinned-record` and `platform` annotations. npm
126-
now records six dependency descriptors, pnpm and Yarn record seven, and no separate `npm-cli`
126+
records six dependency descriptors, pnpm and Yarn record seven, and no separate `npm-cli`
127127
descriptor is introduced.
128-
- Added the `runner-image` build-environment descriptor to JS/TS npm provenance (ADR 0100): the
129-
descriptor's `image_version` carries the runner VM's baked image metadata version verbatim, while
130-
the platform's control-plane deployment version is recorded as a separate non-authoritative
131-
`deployment_version` annotation, so GitHub runner image rollout windows do not fail honest builds.
128+
- Added the `runner-image` build-environment descriptor to JS/TS npm provenance (ADR 0100, ADR 0111,
129+
ADR 0112): the descriptor's annotation set is exactly `deployment_version`, `operating_system`,
130+
`image_version`, and `runner_label`. `image_version` carries the runner VM's baked image metadata
131+
version verbatim, and `operating_system` carries the on-disk image metadata's Operating System
132+
detail from the same bounded snapshot, while the platform's control-plane deployment version is
133+
recorded as a separate non-authoritative `deployment_version` annotation, so GitHub runner image
134+
rollout windows do not fail honest builds. The ambient `ImageOS` variable is diagnostic-only and
135+
never feeds the signed record.
136+
- Added the finalized JS/TS npm SLSA provenance contract (ADR 0103-0112).
137+
`externalParameters.workflow` records exactly the called workflow's `ref`, `repository`, and
138+
`path`, and `internalParameters.github` is a closed triple of `event_name`, `repository_id`, and
139+
`repository_owner_id`, bound to the OIDC Build Trigger and Build Config URI claims and to the
140+
signing certificate's platform-fixed claims. `resolvedDependencies` records the ordered chain of
141+
`invocation-source`, `built-source`, `package-manifest`, `lockfile`, `node-runtime`, a
142+
`package-manager-distribution` for non-npm managers, and `runner-image`; the signed
143+
package-manifest descriptor carries offline `manifest_evidence` (`path` plus base64 content) so
144+
verifiers can recompute it without repository access. `builder.version` records the observed
145+
`nodejs`, `npm`, and conditionally `corepack` versions, and build script invocations are recorded
146+
as `runDetails.metadata.windlass_build_script_disposition`.
132147
- Added redacted, best-effort human-readable stderr diagnostics for external-process lifecycle, npm
133148
publish failures, and registry read-back transitions, including a filtered stderr relay for
134149
allowlisted processes on success and failure. The relay redacts exact known token values, strips
@@ -140,34 +155,6 @@ Era five-digit years (e.g., `## [0.1.0] - 12026-06-13`).
140155
cannot change canonical reports, registry or verifier operations, classification, retries, or
141156
publish outcomes.
142157

143-
### Changed
144-
145-
- **Breaking:** Finalized the JS/TS npm SLSA provenance contract per ADR 0103-0112.
146-
`externalParameters.workflow` now records exactly the called workflow's `ref`, `repository`, and
147-
`path`, while the legacy environment snapshots are removed from the signed record.
148-
`internalParameters.github` is a closed triple of `event_name`, `repository_id`, and
149-
`repository_owner_id`, bound to the OIDC Build Trigger and Build Config URI claims and to the
150-
signing certificate's platform-fixed claims. `resolvedDependencies` records the ordered chain of
151-
`invocation-source`, `built-source`, `package-manifest`, `lockfile`, `node-runtime`, a
152-
`package-manager-distribution` for non-npm managers, and `runner-image`; the signed
153-
package-manifest descriptor carries offline `manifest_evidence` (`path` plus base64 content) so
154-
verifiers can recompute it without repository access. `builder.version` records the observed
155-
`nodejs`, `npm`, and conditionally `corepack` versions, and build script invocations are recorded
156-
as `runDetails.metadata.windlass_build_script_disposition`.
157-
- **Breaking:** The `runner-image` descriptor's annotation set is now exactly `deployment_version`,
158-
`operating_system`, `image_version`, and `runner_label` (ADR 0111, ADR 0112). `operating_system`
159-
carries the on-disk image metadata's Operating System detail from the same bounded snapshot as
160-
`image_version`; the ambient `ImageOS` variable is diagnostic-only and never feeds the signed
161-
record.
162-
163-
### Removed
164-
165-
- **Breaking:** Removed the `release-tag` and `provenance-sidecar` optional inputs from the JS/TS
166-
npm reusable workflow (ADR 0108), shrinking the public contract to one required input
167-
(`package-directory`) and six optional inputs. The release target tag is derived from the signed
168-
invocation context instead of a caller input, and release-asset publication always receives the
169-
provenance sidecar.
170-
171158
### Security
172159

173160
- [CVE-2026-33818](https://osv.dev/vulnerability/CVE-2026-33818),

0 commit comments

Comments
 (0)