Skip to content

Commit 57a9f11

Browse files
committed
docs: Improve README with Release instructions.
1 parent 813b32c commit 57a9f11

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,13 @@ Waiting for deployment capacity......
6767

6868
The CLI client in particular is a bit experimental, and not yet finished. Any
6969
pull-requests to improve it would be greatly welcomed.
70+
71+
## Release
72+
73+
This project uses [Google's release-please](https://github.com/googleapis/release-please) action which automates CHANGELOG generation, the creation of GitHub releases, and version bumps.
74+
75+
**Commit messages are important!**
76+
77+
`release-please` assumes that you are following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
78+
This means that your commit messages should be structured in a way that release-please can determine the type of change that has been made.
79+
Please refer to the ["How should I write my commits"](https://github.com/googleapis/release-please?tab=readme-ov-file#how-should-i-write-my-commits) documentation.

0 commit comments

Comments
 (0)