Skip to content

Commit 09fe553

Browse files
Do not auto bump package.json (#328)
## Why Auto bumping package.json in CI requires pushing to `main`. We should create a PR to bump version instead. ## What changed - Remove prepare-release.yml - Update README ## Versioning - [ ] Breaking protocol change - [ ] Breaking ts/js API change <!-- Kind reminder to add tests and updated documentation if needed -->
1 parent de29abc commit 09fe553

File tree

3 files changed

+21
-66
lines changed

3 files changed

+21
-66
lines changed

.github/workflows/prepare-release.yml

Lines changed: 0 additions & 51 deletions
This file was deleted.

.github/workflows/publish.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22
name: Build and Publish Package
33

44
on:
5-
push:
6-
tags:
7-
- 'v*' # Trigger on tags like v1.0.0, v2.3.4, etc.
5+
release:
6+
types: [published]
87

98
jobs:
109
build-and-publish:

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -285,19 +285,26 @@ River uses an automated release process with [Release Drafter](https://github.co
285285
- Updates the draft release notes with PR titles
286286
- You can view the draft at [GitHub Releases](../../releases)
287287

288-
2. **When ready to release**:
288+
2. **When ready to release, create a version bump PR**:
289289

290-
- Go to [Actions](../../actions/workflows/prepare-release.yml)
291-
- Click "Run workflow" to open the configuration dialog
292-
- Click "Run workflow" again to confirm and start the process (version is automatically determined from draft release)
290+
- Create a PR that bumps the version in `package.json` and `package-lock.json`. You can run `pnpm version --no-git-tag-version <version>` to bump the version.
291+
- Use semantic versioning:
292+
- `patch` - Bug fixes, small improvements (e.g., 0.208.4 → 0.208.5)
293+
- `minor` - New features, backwards compatible (e.g., 0.208.4 → 0.209.0)
294+
- `major` - Breaking changes (e.g., 0.208.4 → 1.0.0)
295+
- Merge the PR to main
293296

294-
The version bump is automatically calculated based on PR labels:
297+
3. **Publish the GitHub release**:
295298

296-
- `patch` - Bug fixes, small improvements (e.g., 0.208.4 → 0.208.5)
297-
- `minor` - New features, backwards compatible (e.g., 0.208.4 → 0.209.0)
298-
- `major` - Breaking changes (e.g., 0.208.4 → 1.0.0)
299+
- Go to [GitHub Releases](../../releases)
300+
- Find the draft release and click "Edit"
301+
- Update the tag to match your new version (e.g., `v0.209.0`)
302+
- Click "Publish release"
299303

300-
3. **Automation takes over**:
301-
- The "Prepare Release" workflow bumps the version and creates a git tag
302-
- The git tag automatically triggers the "Build and Publish" workflow
303-
- The `river` package is published to NPM and the GitHub release is created
304+
4. **Automation takes over**:
305+
306+
- Publishing the release automatically triggers the "Build and Publish" workflow
307+
- The `river` package is published to NPM
308+
309+
5. **Manual npm release**:
310+
- If the auto-publish workflow failed, you can run `npm run release` locally

0 commit comments

Comments
 (0)