Skip to content

docs: add release provenance guidance - #3343

Merged
samayer12 merged 1 commit into
ci/verify-release-provenancefrom
docs/release-provenance
Sep 15, 2026
Merged

samayer12 merged 1 commit into
ci/verify-release-provenancefrom
docs/release-provenance

Conversation

@samayer12

@samayer12 samayer12 commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Summary

  • document GitHub and npm provenance verification for Pepr releases
  • explain how consumers should evaluate attestation identities and digests
  • describe the post-publish verification job and current SLSA Build L2 assurance
  • record the release invariants maintainers must preserve
  • link the guide from Pepr security best practices

Stack

Validation

  • markdownlint passes
  • release workflow passes Prettier validation
  • git diff --check passes

@codecov

codecov Bot commented Sep 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.98%. Comparing base (a8af08b) to head (829eefc).

Additional details and impacted files

Impacted file tree graph

@@                      Coverage Diff                      @@
##           ci/verify-release-provenance    #3343   +/-   ##
=============================================================
  Coverage                         77.98%   77.98%           
=============================================================
  Files                                92       92           
  Lines                              2548     2548           
  Branches                            545      545           
=============================================================
  Hits                               1987     1987           
  Misses                              439      439           
  Partials                            122      122           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@samayer12
samayer12 force-pushed the docs/release-provenance branch 2 times, most recently from 63f8d23 to c1e824c Compare September 15, 2026 21:37
@samayer12
samayer12 changed the base branch from main to ci/verify-release-provenance September 15, 2026 21:37
@samayer12
samayer12 added this pull request to stack #3345 September 15, 2026 21:38
Document how consumers verify Pepr npm releases and the invariants maintainers must preserve in the release workflow.

Constraint: Limit guidance to the attested npm tarball
Confidence: high
Scope-risk: narrow
@samayer12
samayer12 force-pushed the docs/release-provenance branch from c1e824c to 829eefc Compare September 15, 2026 21:41
@samayer12
samayer12 marked this pull request as ready for review September 15, 2026 21:43
@samayer12
samayer12 requested a review from a team as a code owner September 15, 2026 21:44
@greptile-apps

greptile-apps Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

The documentation-only change appears safe to merge, with no concrete correctness, security, or integration issue identified.

Summary

This PR adds consumer and maintainer guidance for verifying Pepr npm release provenance.

  • Documents GitHub Artifact Attestation and npm provenance verification.
  • Explains attestation identity, digest, source, and SLSA assurance.
  • Records the release workflow's artifact-identity invariants and historical provenance baseline.
  • Links the new guidance from the security best-practices page.

Diagram

%%{init: {'theme': 'neutral'}}%%
flowchart LR
  B[Build npm tarball once] --> D[Record SHA-256 digest]
  D --> A[Verify digest and create GitHub attestation]
  A --> P[Verify digest and publish through npm]
  P --> V[Download published package]
  V --> C[Compare build and published digests]
  C --> G[Verify GitHub attestation]
  C --> N[Verify npm signatures and provenance]
  P --> O[Verify digest and push OCI package]
Loading

Reviews (1) · Last reviewed commit: "docs: add release provenance guidance"

@github-project-automation github-project-automation Bot moved this to 👀 In review in Pepr Project Board Sep 15, 2026
@samayer12
samayer12 added this pull request to the merge queue Sep 15, 2026
Merged via the queue into main with commit f9e2735 Sep 15, 2026
28 checks passed
@samayer12
samayer12 deleted the docs/release-provenance branch September 15, 2026 22:29
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Done in Pepr Project Board Sep 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants