feat(release): platform READMEs + npm linked-artifacts storage records#38
Merged
Conversation
- prepare-npm-platform-packages: emit a minimal per-platform README that points users to @bosdev/zaps, and ship it via the package files list - release.yml: after publish, register an org Artifact Metadata storage record per package (main + 4 platform) so they surface on the org's Linked Artifacts page; best-effort (continue-on-error) so a missing entitlement never breaks a release. Adds attestations + artifact-metadata write permissions.
Coverage Report for Unit Tests
File CoverageNo changed files found. |
Coverage Report for Integration Tests
File CoverageNo changed files found. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Two release-workflow improvements for the npm distribution.
1. Per-platform package READMEs
scripts/prepare-npm-platform-packages.tsnow emits a minimalREADME.mdfor each@bosdev/zaps-<platform>package (and ships it via the packagefileslist). Todaythose packages publish with a bare npm page; now each one explains it's just the
prebuilt native binary and points users to install
@bosdev/zapsinstead.2. npm linked artifacts (storage records)
After publishing, the
npmjob registers an org Artifact Metadata storage recordper published package (main + 4 platform) against
registry.npmjs.org, so they surfaceon the org's Linked Artifacts page. The
digest is the tarball
sha512(matches the provenance attestation, so GitHub auto-linksit). The step is best-effort (
continue-on-error) — a missing entitlement or APIrejection logs and moves on, never breaking a release. Adds
attestations: write+artifact-metadata: writepermissions.Verification
files;package.jsonmutation reverted.@bosdev/zaps@0.8.3tarballsha512sum.404 no artifacts found).bash -non the new step passes; YAML indentation checked.Notes
(the local probe confirms the endpoint exists, not that the CI token is authorized).
resolution.