From f9267e2b3e5ef33dc3228dd647dd448b8ec9bfb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lubo=C5=A1=20Pokorn=C3=BD?= Date: Fri, 9 Jan 2026 19:24:47 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20describe=20the=20release?= =?UTF-8?q?=20proces?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 ++ RELEASE.md | 16 ++++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 RELEASE.md diff --git a/README.md b/README.md index 553b050..6192de0 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,8 @@ await home.list_objects() ## Development +Please see [RELEASE.md](RELEASE.md) for the release process. + Project is managed using [Hatch](https://hatch.pypa.io/latest/). ### Testing diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..6327bc9 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,16 @@ +# H2O Cloud Discovery Client Release Process + +- Releases are handled by [Release Please](https://github.com/googleapis/release-please) +[GitHub Action](https://github.com/googleapis/release-please-action) that executes on + all commits to the default branch. +- Commits to the default branch should follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) syntax. +- If the default branch contains commits that lead to the increment of a version number Release Please + will automatically create a PR that when merged will create a new release. +- Release PR is created by the GitHub Action bot as a draft, which means that CI checks are not automatically triggered. +- To activate the PR non-bot maintainer needs to contribute to the PR. + - This can usually be done by adding an empty commit and pushing it to the PR branch. + + ```sh + git commit --allow-empty --message "Activate release PR" + git push + ```