Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: bumping version to 0.17.0 #790

Merged
merged 1 commit into from
Oct 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions docs/patching.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
## Patching Process

To patch a released version, start by creating a dedicated branch for that version, proceed with the required updates, and eventually release the patched branch.

1. **Creating Environment Variables**

Let's create environment variables for the patch version. For the rest of this document, we will use these environment variables in the commands.

```bash
PRV_VER="0.16.0"
CUR_VER="0.16.1"
NEXT_VER="0.16.2"
TAG_NAME="v${CUR_VER}"
TAG_MSG="Version ${CUR_VER}"
BASE_BRANCH="0.16.x"
BASE_VER="0.16.0"
```

For the rest of this document, we will use these environment variables in commands.
Keep your terminal open.

2. **Creating a new branch**

If this is the first patch for the specific major version, we need to first create a branch for this tag:

```bash
git checkout -b ${BASE_BRANCH} v${BASE_VER}
git branch --set-upstream-to=origin/${BASE_BRANCH}
```

and update the patch version inside the [version.go](../version/version.go) file.

Otherwise, switch to the patch branch:

```bash
git checkout ${BASE_BRANCH}
```

3. **Updating the branch**

Apply the fixes to the branch. You can use [cherry-pick](https://www.atlassian.com/git/tutorials/cherry-pick) to pick some commits from the main branch and apply them to the patch branch:

```bash
git cherry-pick <commit-id>
```

4. **Follow the [Releasing](./releasing.md) Document**

Please refer to the [Releasing](./releasing.md) document and follow the steps outlined from Step 4 until the end to complete the patching process.
9 changes: 5 additions & 4 deletions docs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ Let's create environment variables for the release version.
For the rest of this document, we will use these environment variables in the commands.

```bash
PRV_VER="0.15.0"
CUR_VER="0.16.0"
NEXT_VER="0.17.0"
PRV_VER="0.16.0"
CUR_VER="0.17.0"
NEXT_VER="0.18.0"
TAG_NAME="v${CUR_VER}"
TAG_MSG="Version ${CUR_VER}"
BASE_BRANCH="main"
Expand Down Expand Up @@ -106,7 +106,8 @@ Pushing the tag will automatically create a release tag and build the binaries.

9. **Bumping version**

Update the version inside the [version.go](../version/version.go) and [patching](./patching.md) docuemnts.
Update the version inside the [version.go](../version/version.go) and add `beta` to the `meta` field.
Update [patching](./patching.md) docuemnt.
If this is a majore release, update the version inside this document in step 3.

Create a new PR against base branch:
Expand Down
4 changes: 2 additions & 2 deletions version/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ import (
// These constants follow the semantic versioning 2.0.0 spec (http://semver.org/)
const (
major uint = 0
minor uint = 16
minor uint = 17
patch uint = 0
meta string = ""
meta string = "beta"
)

var build string
Expand Down
Loading