Skip to content

Commit 73cfc3b

Browse files
committed
docs: Improve README with Release instructions.
1 parent b911f9a commit 73cfc3b

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
@@ -25,3 +25,13 @@ Start agent in background
2525
```
2626
$ deploy-agent start
2727
```
28+
29+
## Release
30+
31+
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.
32+
33+
**Commit messages are important!**
34+
35+
`release-please` assumes that you are following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
36+
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.
37+
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)