You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -258,8 +258,8 @@ packaging/npm/
258
258
6. Smoke-tests the published wrapper with `npx --yes agoraio-cli@<tag> --version` (retry/backoff for registry propagation)
259
259
260
260
**Prerequisites:**
261
-
-`NPM_TOKEN` secret in the repo, with publish access to `agoraio-cli` and all unscoped `agoraio-cli-*` platform packages.
262
-
-`id-token: write` workflow permission (already set in `release.yml`) — required for npm provenance.
261
+
-npm **Trusted Publisher** configured on each package (`agoraio-cli` and all `agoraio-cli-*`), pointing at repo `AgoraIO/cli` and workflow `release.yml`.
262
+
-`id-token: write` workflow permission (already set in `release.yml`) — required for trusted publishing and provenance.
263
263
264
264
**Manual dry-run:** the workflow exposes `workflow_dispatch` with a `dry_run` input that runs `npm publish --dry-run` against a synthetic version, validating packaging without publishing.
-Authenticates via [npm trusted publishing](https://docs.npmjs.com/trusted-publishers/) (OIDC from GitHub Actions — no `NPM_TOKEN` secret)
29
+
- Requires `id-token: write` workflow permission (already set in `release.yml`)
30
30
31
31
3.**Apt repository** job (triggered by the published release):
32
32
- Downloads `.deb` files from the release
@@ -63,17 +63,19 @@ The release workflow exposes a `workflow_dispatch` trigger that runs the npm pub
63
63
64
64
Before tagging the first real release that ships npm, confirm:
65
65
66
-
-[ ]`NPM_TOKEN` secret is set in the repo (Settings → Secrets and variables → Actions). Token must have publish access to `agoraio-cli` and all unscoped `agoraio-cli-*` platform packages.
66
+
-[ ] Each npm package has a **Trusted Publisher** configured on [npmjs.com](https://www.npmjs.com) (Package → Settings → Trusted Publisher → GitHub Actions):
67
+
- Repository: `AgoraIO/cli`
68
+
- Workflow filename: `release.yml`
69
+
- Configure for `agoraio-cli` and all six `agoraio-cli-{os}-{arch}` platform packages
67
70
-[ ]`agoraio-cli` and `agoraio-cli-*` package names on npmjs.com are owned by the Agora npm org / publisher and not squatted.
68
-
-[ ] The workflow has `id-token: write` permission (already set in `release.yml`); npm provenance requires it.
69
-
-[ ] A `workflow_dispatch` dry-run on the current `main` succeeds end-to-end (validates packaging, scripts, provenance).
71
+
-[ ] The workflow has `id-token: write` permission (already set in `release.yml`); trusted publishing and provenance require it.
72
+
-[ ] A `workflow_dispatch` dry-run on the current `main` succeeds end-to-end (validates packaging and tarball contents).
70
73
-[ ] First publish should be a release-candidate tag (e.g. `v0.1.x-rc.1`) so an unexpected failure does not affect a "latest" tag in the registry.
0 commit comments