From 940ab2c34a6953b5550db6ffbfb94a2aa587f589 Mon Sep 17 00:00:00 2001 From: Adam Ruberti <5392248+ariwk@users.noreply.github.com> Date: Wed, 24 Apr 2024 17:49:16 +0200 Subject: [PATCH] chore: add RELEASE.md initial version --- RELEASE.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..797481b --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,19 @@ + +**Guidelines for Releases** + +**Code Ownership and Automated Release Management** + +Releases within our project are exclusively overseen by designated code owners, as outlined in the [/ .github / CODEOWNERS](/.github/CODEOWNERS) file. Our release process is automated using the Release Please GitHub action, which is configured in [/ .github / workflows / release-please.yml](/.github/workflows/release-please.yml). + +**Overview of the Workflow:** + +1. For the initial release, the Release Please GitHub action generates a pull request entitled "chore(main): release 1.0.0", marking the commencement of version 1.0.0. This pull request necessitates approval as required. + +2. Following the triumphant launch of the initial version, the action automatically generates another pull request to advance the version to 1.0.1-SNAPSHOT. Prompt approval of this pull request is encouraged post the inaugural release. + +3. Whenever alterations are introduced to the main branch, the Release Please GitHub action dynamically creates or updates the existing pull request, titled "chore(main): release X.Y.Z", where X.Y.Z denotes the version calculated based on Git message history. + +4. Subsequent to each release, the process iterates to update the version to X.Y.Z-SNAPSHOT, thereby preparing a new pull request for the forthcoming X.Y.Z version release. + + +For comprehensive information, please consult the [Release Please documentation](https://github.com/googleapis/release-please).