Skip to content

docs: state that npm adds provenance to releases of the public repository #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emaarco merged 1 commit into from
Oct 28, 2026
Merged

docs: state that npm adds provenance to releases of the public repository #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/release-please.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ jobs:
- run: npm ci
- run: npm run build
- run: npm test
# no NODE_AUTH_TOKEN: npm exchanges the GitHub OIDC token. No --provenance: npm only creates
# provenance for public repositories.
# no NODE_AUTH_TOKEN: npm exchanges the GitHub OIDC token. No --provenance: npm adds it to
# trusted publishes on its own.
- run: npm publish

homebrew:
Expand Down
5 changes: 3 additions & 2 deletions docs/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,9 @@ with the version and, to only build and test the formula, `dry-run`.

- Requirements for the `publish` job: GitHub-hosted runner, `id-token: write`, npm 11.5.1 or later (the
job installs the latest npm). `repository.url` in `package.json` must match `Miragon/bpmn-cli` exactly.
- The repository is private, so npm creates no provenance attestation. When the repository becomes
public, npm adds provenance to trusted publishes automatically.
- npm adds a provenance attestation to every trusted publish from this public repository on its own,
so `npm publish` needs no `--provenance`. Every version since 0.1.1 has one; only 0.1.0, the manual
first publish, has none.
- release-please uses the default `GITHUB_TOKEN`. Tags and releases created with it do not trigger other
workflows, which is why `publish` runs as a job of the same workflow, gated on `release_created`.
- The repository setting "Allow GitHub Actions to create and approve pull requests" must stay enabled.
Loading