docs: add Releasing section to README #57
Conversation
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
![doist-bot[bot]](https://avatars.githubusercontent.com/in/2345791?s=60&v=4){kind=small}
There was a problem hiding this comment.
This PR introduces a helpful 'Releasing' section to the README, clarifying the release process using release-please and conventional commits, which significantly enhances understanding of how releases are triggered and managed. To ensure full clarity, it would be beneficial to expand the section on major releases to explicitly mention the BREAKING CHANGE: footer as an additional trigger for major version increments.
|
|
||
| ## 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. |
There was a problem hiding this comment.
[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.
There was a problem hiding this comment.
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
1 participant
This PR documents the release process using release-please and conventional commits.