Skip to content

Commit

Permalink
chore: bumping version to 0.20.0 (#904)
Browse files Browse the repository at this point in the history
  • Loading branch information
themantre committed Jan 4, 2024
1 parent fbeb6ec commit b222d00
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 19 deletions.
28 changes: 18 additions & 10 deletions docs/patching.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# Patching Process

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

## 1. Preparing Your Environment

Before proceeding with the patching process, ensure that your `origin` remote is set to `git@github.com:pactus-project/pactus.git` and not your local fork.
Before proceeding with the patching process,
ensure that your `origin` remote is set to `git@github.com:pactus-project/pactus.git` and not your local fork.

## 2. Create a Patch Branch

If this is the first patch for a specific major version, you'll need to create a branch for this tag. Replace `<minor>` with the appropriate minor version number:
If this is the first patch for a specific major version, you'll need to create a branch for this tag.
Replace `<minor>` with the appropriate minor version number:

```bash
git checkout -b 0.<minor>.x v0.<minor>.0
Expand All @@ -27,7 +30,9 @@ git pull

## 3. Apply Fixes

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

```bash
git cherry-pick <commit-id>
Expand All @@ -36,19 +41,22 @@ git push

## 4. Set Environment Variables

Reopen this document within the branch version and create environment variables for the release version, which will be used in subsequent commands throughout this document. Keep your terminal open for further steps.
Reopen this document within the branch version and
create environment variables for the release version, which will be used in subsequent commands throughout this document.
Keep your terminal open for further steps.

```bash
PRV_VER="0.19.0"
CUR_VER="0.19.1"
NEXT_VER="0.19.2"
PRV_VER="0.20.0"
CUR_VER="0.20.1"
NEXT_VER="0.20.2"
TAG_NAME="v${CUR_VER}"
TAG_MSG="Version ${CUR_VER}"
BASE_BRANCH="0.19.x"
BASE_BRANCH="0.20.x"
```

## 5. Follow the Releasing Document

Refer to the [Releasing](./releasing.md) document and follow the steps outlined from Step 5 until the end. This document will provide you with the necessary guidance to successfully release the patched branch.
Refer to the [Releasing](./releasing.md) document and follow the steps outlined from Step 5 until the end.
This document will provide you with the necessary guidance to successfully release the patched branch.

Ensure that your terminal remains open throughout the process for seamless execution of the required commands.
20 changes: 13 additions & 7 deletions docs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ Create environment variables for the release version, which will be used in subs
Keep your terminal open for further steps.

```bash
PRV_VER="0.18.0"
CUR_VER="0.19.0"
NEXT_VER="0.20.0"
PRV_VER="0.19.0"
CUR_VER="0.20.0"
NEXT_VER="0.21.0"
TAG_NAME="v${CUR_VER}"
TAG_MSG="Version ${CUR_VER}"
BASE_BRANCH="main"
Expand Down Expand Up @@ -75,7 +75,7 @@ git push origin HEAD
gh pr create --title "chore: releasing version ${CUR_VER}" --body "Releasing version ${CUR_VER}" --base ${BASE_BRANCH}
```

Await approval and merging of the PR into the base branch.
Wait for the PR to be approved and merged into the main branch.

## 8. Tagging the Release

Expand Down Expand Up @@ -106,7 +106,8 @@ Pushing the tag will automatically create a release tag and build the binaries.
## 10. Bump the Version

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

Create a new PR against the base branch:

Expand All @@ -117,11 +118,16 @@ git push origin HEAD
gh pr create --title "chore: bumping version to ${NEXT_VER}" --body "Bumping version to ${NEXT_VER}" --base ${BASE_BRANCH}
```

Await approval and merging of the PR into the base branch.
Wait for the PR to be approved and merged into the main branch.

## 11. Update the Website

Create a new announcement post on the [blog](https://pactus.org/blog/) and update the [Road Map](https://pactus.org/about/roadmap/) and [Download](https://pactus.org/download/) pages. Additionally, draft a new release on the [GitHub Releases](https://github.com/pactus-project/pactus/releases) page.
Create a new announcement post on the
[blog](https://pactus.org/blog/) and update the
[Road Map](https://pactus.org/about/roadmap/) and
[Download](https://pactus.org/download/) pages.
Additionally, draft a new release on the
[GitHub Releases](https://github.com/pactus-project/pactus/releases) page.

## 12. Celebrate 🎉

Expand Down
4 changes: 2 additions & 2 deletions version/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ import (
// These constants follow the semantic versioning 2.0.0 spec (http://semver.org/)
const (
major uint = 0
minor uint = 19
minor uint = 20
patch uint = 0
meta string = ""
meta string = "beta"
protocolVersion uint = 1
)

Expand Down

0 comments on commit b222d00

Please sign in to comment.