Skip to content

Commit 9b6f1a8

Browse files
authored
docs: 📝 describe the release proces (#133)
1 parent 57079c0 commit 9b6f1a8

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ await home.list_objects()
8787

8888
## Development
8989

90+
Please see [RELEASE.md](RELEASE.md) for the release process.
91+
9092
Project is managed using [Hatch](https://hatch.pypa.io/latest/).
9193

9294
### Testing

RELEASE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# H2O Cloud Discovery Client Release Process
2+
3+
- Releases are handled by [Release Please](https://github.com/googleapis/release-please)
4+
[GitHub Action](https://github.com/googleapis/release-please-action) that executes on
5+
all commits to the default branch.
6+
- Commits to the default branch should follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) syntax.
7+
- If the default branch contains commits that lead to the increment of a version number Release Please
8+
will automatically create a PR that when merged will create a new release.
9+
- Release PR is created by the GitHub Action bot as a draft, which means that CI checks are not automatically triggered.
10+
- To activate the PR non-bot maintainer needs to contribute to the PR.
11+
- This can usually be done by adding an empty commit and pushing it to the PR branch.
12+
13+
```sh
14+
git commit --allow-empty --message "Activate release PR"
15+
git push
16+
```

0 commit comments

Comments
 (0)