Skip to content

docs: add Releasing section to README #57

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
frankieyan merged 1 commit into from
Feb 5, 2026
Merged

docs: add Releasing section to README #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,12 @@ if [ -n "$FILES" ]; then
fi
```

## Releasing

This project uses [release-please](https://github.com/googleapis/release-please) to automate releases. Commits merged to `main` with `fix:` trigger patch releases, `feat:` triggers minor releases, and `feat!:` or `fix!:` triggers major releases.
Copy link

@doist-bot doist-bot bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P2] This sentence states major releases are triggered only by feat!: or fix!:. With conventional commits/release-please, a breaking change can also be indicated by a BREAKING CHANGE: footer even without the !, which would still trigger a major release. This doc would mislead for commits that use the footer form; consider mentioning BREAKING CHANGE as another major trigger.

Copy link
Member Author

@frankieyan frankieyan Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The footers are for multiple entries in a single commit/PR. Let's keep it simple and go with the simple prefixes: https://github.com/googleapis/release-please#how-should-i-write-my-commits


When commits land on `main`, release-please creates a release PR. Merging it publishes to npm and GitHub Packages.

## License

Released under the [MIT License](https://opensource.org/licenses/MIT).