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: docs/releasing.md
+8-13Lines changed: 8 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ MiniWeb publishes to npm as `@async/miniweb`.
4
4
5
5
## Normal Release Flow
6
6
7
-
MiniWeb uses Release Please. Merge Conventional Commit changes into `main`; the release workflow opens or updates a release PR that bumps `package.json`, updates `package-lock.json`, and updates `CHANGELOG.md`.
7
+
MiniWeb includes Release Please config for changelog and version PRs. Merge Conventional Commit changes into `main`; then create a release PR with Release Please once GitHub Actions PR creation is enabled for the `async-framework` organization or a dedicated release token is configured.
8
8
9
-
When the release PR merges, the workflow creates the GitHub Release, verifies the package, publishes to npm, and attaches the exact packed tarball to the GitHub Release.
9
+
When the release PR merges, push the release tag. The `Release` workflow verifies the package, publishes to npm through Trusted Publishing, creates the GitHub Release if needed, and attaches the exact packed tarball to the GitHub Release.
10
10
11
11
## npm Trusted Publishing
12
12
@@ -19,23 +19,18 @@ Configure npm Trusted Publishing for this package before the first automated pub
19
19
20
20
The workflow uses GitHub OIDC with `id-token: write`; it does not use an `NPM_TOKEN` secret.
21
21
22
+
The repository workflow is tag-triggered because the `async-framework` organization currently blocks `GITHUB_TOKEN` from creating pull requests. To let Release Please open changelog PRs from Actions, an organization admin must allow GitHub Actions to create pull requests, or the workflow must be updated to use a dedicated release token.
23
+
22
24
## First Release
23
25
24
-
The first package version is `0.1.0`. After the release automation is pushed and npm Trusted Publishing is configured, create and push the initial tag:
26
+
The first package version is `0.1.0`. It was published manually from a verified tarball because npm Trusted Publishing can only be configured after the package exists. Future releases should use the tag-triggered workflow after Trusted Publishing is configured.
25
27
26
28
```sh
27
-
git tag v0.1.0
28
-
git push origin main v0.1.0
29
-
```
30
-
31
-
Then run the `Release` workflow manually with:
32
-
33
-
```txt
34
-
tag: v0.1.0
29
+
npm run release:check
30
+
git tag vX.Y.Z
31
+
git push origin main vX.Y.Z
35
32
```
36
33
37
-
The manual workflow path exists so the first release can publish the already prepared initial version. Future releases should use Release Please PRs.
0 commit comments