Skip to content

Commit

Permalink
docs: update RELEASE.md with the correct workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
ariwk committed Jun 4, 2024
1 parent 3d68f31 commit ecc9cf5
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,21 @@

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:
## Workflow Overview

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.
1. **Initial Release**:
- The Release Please GitHub action generates a pull request titled `chore(main): release 1.0.0`, initiating version 1.0.0.
- This pull request requires approval from the designated code owners.

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.
2. **Subsequent Releases**:
- When changes are merged into the main branch, the Release Please GitHub action creates or updates an existing pull request titled `chore(main): release X.Y.Z`, where X.Y.Z is the version number derived from the commit history.

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.
3. **Forcing a Specific Release Version**:
- To manually set the next release version, create an empty commit on a new branch and merge it manually. Use the following command to create the empty commit:

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.
```sh
git commit --allow-empty -m "chore: release 62.1.0" -m "Release-As: 62.1.0"
```
- Then, create a pull request from this branch and merge it manually.


For comprehensive information, please consult the [Release Please documentation](https://github.com/googleapis/release-please).
For comprehensive information, please consult the [Release Please documentation](https://github.com/googleapis/release-please).

0 comments on commit ecc9cf5

Please sign in to comment.