Skip to content

Fix npm publish command in workflow #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daweifeng-replit merged 2 commits into from
Jun 16, 2025
Merged

Fix npm publish command in workflow #326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dae53fe
Fix npm publish command in workflow
daweifeng-replit Jun 16, 2025
fc23277
fix format
daweifeng-replit Jun 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/npmjs-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ jobs:
run: |
npm set "//registry.npmjs.org/:_authToken" "${{ secrets.NPMJS_AUTH_TOKEN }}"
npm install --frozen-lockfile
npm run publish
npm run release
35 changes: 34 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,4 +272,37 @@ You can find more service examples in the [E2E test fixtures](https://github.com
- `npm run check` -- lint
- `npm run format` -- format
- `npm run test` -- run tests
- `npm run publish` -- cut a new release (should bump version in package.json first)
- `npm run release` -- cut a new release (should bump version in package.json first)

## Releasing

River uses an automated release process with [Release Drafter](https://github.com/release-drafter/release-drafter) for version management and NPM publishing.

### Automated Release Process (Recommended)

1. **Label your PRs** with the appropriate version bump:

- `patch` - Bug fixes, small improvements (e.g., 0.208.4 → 0.208.5)
- `minor` - New features, backwards compatible (e.g., 0.208.4 → 0.209.0)
- `major` - Breaking changes (e.g., 0.208.4 → 1.0.0)

2. **Merge PRs to main** - Release Drafter automatically:

- Creates/updates a draft release with the calculated version
- Generates release notes from PR titles
- Determines version bump based on the highest label used

3. **Publish the release** when ready:
- Go to [GitHub Releases](../../releases)
- Review the draft release notes
- Click "Publish release"
- This automatically publishes to NPM

### Manual Release (Alternative)

For hotfixes or special cases, you can manually trigger a release:

1. Go to [Actions](../../actions/workflows/npmjs-publish.yml)
2. Click "Run workflow"
3. Enter the desired version (e.g., `0.208.5`)
4. Click "Run workflow"
Loading