-
Notifications
You must be signed in to change notification settings - Fork 193
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
docs(release): Add release process docs #701
Merged
Merged
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
34d2c31
Add release process
NibiruHeisenberg 9058034
Update CHANGELOG.md
NibiruHeisenberg 9abde15
Merge branch 'master' into docs/release-guide
matthiasmatt 50111be
Merge branch 'master' into docs/release-guide
AgentSmithMatrix 89e3a8d
Merge branch 'master' into docs/release-guide
NibiruHeisenberg 558af68
Add linux:arm64
NibiruHeisenberg 3ab5cae
Merge branch 'master' into docs/release-guide
NibiruHeisenberg 3c67674
Merge branch 'master' into docs/release-guide
NibiruHeisenberg 9f0a87c
Merge branch 'master' into docs/release-guide
NibiruHeisenberg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Release Process | ||
|
||
This document outlines the process for releasing a new version of the Nibiru binary. | ||
|
||
## Step 1) Create a new release branch off master | ||
|
||
```sh | ||
git checkout master | ||
git branch releases/v0.x.y | ||
git switch releases/v0.x.y | ||
``` | ||
|
||
## Step 2) Update the changelog | ||
|
||
- Move the changelog notes from `Unreleased` to a new section titled `v0.x.y` | ||
- Add the date to `v0.x.y` | ||
|
||
## Step 3) Create a tag | ||
|
||
```sh | ||
git tag -a -s -m "Create new release v0.x.y" v0.x.y | ||
git push origin v0.x.y | ||
``` | ||
|
||
## Step 4) Go to the [GitHub Releases](https://github.com/NibiruChain/nibiru/releases) page | ||
|
||
- Create a new release from the tag v0.x.y you just pushed | ||
- Make sure you save the release as a draft release | ||
- Make sure you check the `This is a pre-release` checkbox | ||
|
||
## Step 5) Build the binaries locally | ||
|
||
```sh | ||
cd nibiru/ | ||
|
||
ignite chain build --release -t linux:amd64 -t linux:arm64 -t darwin:amd64 -t darwin:arm64 | ||
``` | ||
|
||
## Step 6) Upload the files in the release/ directory to GitHub | ||
|
||
Upload all the files under `releases/` to the [GitHub Release](https://github.com/NibiruChain/nibiru/releases) you just made | ||
|
||
## Step 7) Merge your release branch into master | ||
|
||
After merging the release branch `releases/v0.x.y` into master, uncheck the `This is a pre-release` checkbox for the release. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the tag should happen at the end, when everything is sure and is going to be merged.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As discussed in Slack, you need a tag in order to create a release in GitHub.