Skip to content
Merged
Changes from all commits
Commits
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
30 changes: 23 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,13 +267,29 @@ All operations chain with `.method()` syntax for consistency with JavaScript's n

## Release Process

1. Update version in `package.json`
2. Run tests: `npm test`
3. Build: `npm run build`
4. Commit changes
5. Tag release: `git tag v1.0.0`
6. Push: `git push && git push --tags`
7. Publish: `npm publish`
1. Create a branch with the appropriate naming convention (see below)
2. Make your changes
3. Run tests: `npm test`
4. Build: `npm run build`
5. Commit changes
6. Create a pull request to `main`
7. Once merged, the GitHub Actions workflow will automatically:
- Bump the version based on branch name
- Build the package
- Publish to npm with provenance

### Branch Naming Convention

The automated release workflow determines the version bump based on your branch name:

- **Patch release** (1.0.0 → 1.0.1): Use `fix/*` or `patch/*`
- Example: `fix/cli-error-handling`, `patch/typo-in-docs`
- **Minor release** (1.0.0 → 1.1.0): Use `add/*` or `minor/*`
- Example: `add/new-filter-method`, `minor/improve-performance`
- **Major release** (1.0.0 → 2.0.0): Use `vnext/*` or `major/*`
- Example: `vnext/breaking-api-change`, `major/remove-deprecated-methods`

If your branch name doesn't match any pattern, it defaults to a major version bump.

## License

Expand Down