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
Releases are published from GitHub Actions with npm trusted publishing. The workflow uses short-lived OIDC credentials and stores no long-lived npm write token in GitHub.
3
+
`pi-sprites` is not currently published to npm, and this repository does not contain an active npm publishing workflow. Users should install directly from GitHub until maintainers announce otherwise.
4
4
5
-
## One-time setup
5
+
```bash
6
+
pi install git:github.com/superfly/pi-sprites
7
+
```
6
8
7
-
The `pi-sprites` npm name is not yet published. A package owner must claim it with the initial public publish, then configure trusted publishing for subsequent releases:
9
+
## Deferred setup checklist
10
+
11
+
When npm publishing becomes available, a package owner should:
8
12
9
13
1. Make this GitHub repository public.
10
14
2. From a clean, reviewed `main` checkout, run `npm ci`, `npm run check`, and `npm run pack:check`.
11
-
3. Authenticate to the intended Fly.io npm owner account and publish `0.1.0` with `npm publish`. The package's `publishConfig` makes it public.
12
-
4. In the npm package settings, configure a GitHub Actions trusted publisher with:
15
+
3. Confirm ownership of the intended unscoped `pi-sprites` npm name and perform the initial public publish through the approved Fly.io npm account.
16
+
4. Add a reviewed `.github/workflows/publish.yml` that validates the release tag, runs checks, and invokes `npm publish` with OIDC permissions.
17
+
5. In the npm package settings, configure a GitHub Actions trusted publisher with:
13
18
- organization: `superfly`
14
19
- repository: `pi-sprites`
15
20
- workflow filename: `publish.yml`
16
21
- allowed action: `npm publish`
17
-
5. Remove or restrict traditional npm automation tokens after the trusted publisher succeeds.
22
+
6. Remove or restrict traditional npm automation tokens after the trusted publisher succeeds.
18
23
19
24
Do not add an `NPM_TOKEN` secret to this repository. Trusted publishing automatically attaches npm provenance when both the repository and package are public.
20
25
@@ -23,8 +28,6 @@ Do not add an `NPM_TOKEN` secret to this repository. Trusted publishing automati
23
28
1. Update `version` in `package.json` and `package-lock.json`.
24
29
2. Move the relevant entries from `Unreleased` in `CHANGELOG.md` into a versioned section with the release date.
25
30
3. Open and merge a pull request after CI passes.
26
-
4. Publish a GitHub release whose tag is exactly `v<package-version>`.
27
-
28
-
The [publish workflow](../.github/workflows/publish.yml) verifies that the release tag matches `package.json`, installs the locked dependencies, runs the full local check and package dry run, then calls `npm publish`. npm trusted publishing supplies the short-lived credential and provenance.
31
+
4. Publish a GitHub release whose tag is exactly `v<package-version>` after the trusted-publishing workflow is configured.
29
32
30
-
The gated live Sprites test runs on the trusted `main`push before release. It is not rerun by the publish workflow so the npm release path needs no Sprites credential.
33
+
The gated live Sprites test already runs on trusted `main`pushes. A future publish workflow should rely on that result rather than requiring a Sprites credential in the npm release path.
0 commit comments