Skip to content

Commit 227aaa0

Browse files
committed
docs clarify npm trusted publishing prerequisites
1 parent 9b606e9 commit 227aaa0

3 files changed

Lines changed: 4 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,7 @@ packaging/npm/
258258
6. Smoke-tests the published wrapper with `npx --yes agoraio-cli@<tag> --version` (retry/backoff for registry propagation)
259259

260260
**Prerequisites:**
261+
- npm package names already exist on the registry before relying on trusted publishing.
261262
- npm **Trusted Publisher** configured on each package (`agoraio-cli` and all `agoraio-cli-*`), pointing at repo `AgoraIO/cli` and workflow `release.yml`.
262263
- `id-token: write` workflow permission (already set in `release.yml`) — required for trusted publishing and provenance.
263264

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Earlier entries pre-date this convention and only carry their version's compare
1717

1818
### Fixed
1919

20+
- Clarify that npm release publishing uses trusted publishing only and requires every npm package to exist before release automation runs.
2021
- Update GoReleaser Cosign signing to emit `checksums.txt.sigstore.json` with `--bundle`, matching Cosign's current bundle-based signing flow.
2122

2223
## [0.2.2] - 2026-05-26

RELEASING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The release workflow (`.github/workflows/release.yml`) then:
2525
- Publishes the six per-platform packages with `npm publish --provenance`
2626
- Publishes the wrapper package (`agoraio-cli`) with `npm publish --provenance`
2727
- Runs a post-publish smoke test: `npx --yes agoraio-cli@<tag> --version` with retry/backoff to handle registry propagation
28-
- Authenticates via [npm trusted publishing](https://docs.npmjs.com/trusted-publishers/) (OIDC from GitHub Actions — no `NPM_TOKEN` secret)
28+
- Authenticates only via [npm trusted publishing](https://docs.npmjs.com/trusted-publishers/) (OIDC from GitHub Actions)
2929
- Requires `id-token: write` workflow permission (already set in `release.yml`)
3030

3131
3. **Apt repository** job (triggered by the published release):
@@ -63,6 +63,7 @@ The release workflow exposes a `workflow_dispatch` trigger that runs the npm pub
6363

6464
Before tagging the first real release that ships npm, confirm:
6565

66+
- [ ] Each npm package exists on npm. Trusted publishing can only be configured after the package exists.
6667
- [ ] Each npm package has a **Trusted Publisher** configured on [npmjs.com](https://www.npmjs.com) (Package → Settings → Trusted Publisher → GitHub Actions):
6768
- Repository: `AgoraIO/cli`
6869
- Workflow filename: `release.yml`

0 commit comments

Comments
 (0)