Skip to content

Commit

Permalink
Merge branch 'main' into puneet/fix-crisis-keeper
Browse files Browse the repository at this point in the history
  • Loading branch information
mpoke authored Sep 27, 2023
2 parents 0d78905 + 5e3947f commit a1ec04e
Show file tree
Hide file tree
Showing 57 changed files with 172 additions and 276 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ jobs:
# the old gaiad binary version is hardcoded, need to be updated each major release.
- name: Install Old Gaiad
run: |
git checkout v12.0.0
git checkout v13.0.0
make build
cp ./build/gaiad ./build/gaiadold
go clean -modcache
Expand Down
60 changes: 48 additions & 12 deletions RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
- [Release Process](#release-process)
- [Major Release Procedure](#major-release-procedure)
- [Changelog](#changelog)
- [Creating a new release branch](#creating-a-new-release-branch)
- [Cutting a new release](#cutting-a-new-release)
- [Release Notes](#release-notes)
- [Tagging Procedure](#tagging-procedure)
- [Test building artifacts](#test-building-artifacts)
Expand Down Expand Up @@ -44,14 +46,10 @@ An exception are PRs open via the Github mergify integration (i.e., backported P
* Update the [GitHub mergify integration](./.mergify.yml) by adding instructions for automatically backporting commits from `main` to the `release/vY` using the `A:backport/vY` label.
* **PRs targeting directly a release branch can be merged _only_ when exceptional circumstances arise**.
* In the release branch
* Create a new version section in the `CHANGELOG.md`
* All links must point to their respective pull request.
* The `CHANGELOG.md` must contain only the changes of that specific released version.
All other changelog entries must be deleted and linked to the `main` branch changelog ([example]([TBA](https://github.com/cosmos/gaia/blob/release/v9.0.x/CHANGELOG.md))).
* Note: `CHANGELOG.md` should not contain release candidate entries.
* Create a new version section in the `CHANGELOG.md` (follow the procedure described [below](#changelog))
* Create release notes, in `RELEASE_NOTES.md`, highlighting the new features and changes in the version.
This is needed so the bot knows which entries to add to the release page on GitHub.
* Additionally verify that the `UPGRADING.md` file is up to date and contains all the necessary information for upgrading to the new version.
* (To be added in the future) ~~Additionally verify that the `UPGRADING.md` file is up to date and contains all the necessary information for upgrading to the new version.~~
* We freeze the release branch from receiving any new features and focus on releasing a release candidate.
* Finish audits and reviews.
* Add more tests.
Expand All @@ -62,20 +60,58 @@ An exception are PRs open via the Github mergify integration (i.e., backported P
* When bugs are found, create a PR for `main`, and backport fixes to the release branch.
* Create new release candidate tags after bugs are fixed.
* After the team feels the release candidate is mainnet ready, create a full release:
* Update `CHANGELOG.md`.
* Run `make format` to format the code.
* **Note:** The final release MUST have the same commit hash as the latest corresponding release candidate.
* Create a new annotated git tag in the release branch (follow the [Tagging Procedure](#tagging-procedure)). This will trigger the automated release process (which will also create the release artifacts).
* Once the release process completes, modify release notes if needed.

### Changelog

You can obtain the changelog by running:
For PRs that are changing production code, please add a changelog entry in `.changelog` (for details, see [contributing guidelines](./CONTRIBUTING.md#changelog)).

To manage and generate the changelog on Gaia, we currently use [unclog](https://github.com/informalsystems/unclog).

#### Creating a new release branch

Unreleased changes are collected on `main` in `.changelog/unreleased/`.
However, `.changelog/` on `main` contains also existing releases (e.g., `v10.0.0`).
Thus, when creating a new release branch (e.g., `release/v11.x`), the following steps are necessary:

- move to the release branch, e.g., `release/v11.x`
- delete all the sub-folders in `.changelog/` except `unreleased/`
- replace the content of `.changelog/epilogue.md` with the following text
```md
## Previous Versions

[CHANGELOG of previous versions](https://github.com/cosmos/gaia/blob/main/CHANGELOG.md)
```

#### Cutting a new release

Before cutting a _**release candidate**_ (e.g., `v11.0.0-rc0`), the following steps are necessary:

- move to the release branch, e.g., `release/v11.x`
- move all entries in ".changelog/unreleased" to the release version, e.g., `v11.0.0`, i.e.,
```bash
unclog release v11.0.0
```
- update the CHANGELOG.md, i.e.,
```bash
git log --oneline --decorate <previous_version>..<current_version>
unclog build > CHANGELOG.md
```

# example
git log --oneline --decorate v9.0.0..v9.1.0
❗Once the **final release** is cut, the new changelog section must be added to main:

- checkout a new branch from the `main` branch, i.e.,
- bring the new changelog section from the release branch into this branch, e.g.,
```bash
git checkout release/v11.x .changelog/v11.0.0
```
- remove duplicate entries that are both in `.changelog/unreleased/` and the new changelog section, e.g., `.changelog/v11.0.0`
- update the CHANGELOG.md
```bash
unclog build > CHANGELOG.md
```
- open a PR (from this new created branch) against `main`

### Release Notes

Expand Down
182 changes: 0 additions & 182 deletions RELEASING.md

This file was deleted.

4 changes: 2 additions & 2 deletions ante/ante.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ import (
govkeeper "github.com/cosmos/cosmos-sdk/x/gov/keeper"
paramtypes "github.com/cosmos/cosmos-sdk/x/params/types"

gaiaerrors "github.com/cosmos/gaia/v13/types/errors"
gaiafeeante "github.com/cosmos/gaia/v13/x/globalfee/ante"
gaiaerrors "github.com/cosmos/gaia/v14/types/errors"
gaiafeeante "github.com/cosmos/gaia/v14/x/globalfee/ante"
)

// HandlerOptions extend the SDK's AnteHandler options by requiring the IBC
Expand Down
2 changes: 1 addition & 1 deletion ante/gov_ante.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
govkeeper "github.com/cosmos/cosmos-sdk/x/gov/keeper"
govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"

gaiaerrors "github.com/cosmos/gaia/v13/types/errors"
gaiaerrors "github.com/cosmos/gaia/v14/types/errors"
)

// initial deposit must be greater than or equal to 10% of the minimum deposit
Expand Down
6 changes: 3 additions & 3 deletions ante/gov_ante_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ import (
sdk "github.com/cosmos/cosmos-sdk/types"
govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"

"github.com/cosmos/gaia/v13/ante"
gaiaapp "github.com/cosmos/gaia/v13/app"
gaiahelpers "github.com/cosmos/gaia/v13/app/helpers"
"github.com/cosmos/gaia/v14/ante"
gaiaapp "github.com/cosmos/gaia/v14/app"
gaiahelpers "github.com/cosmos/gaia/v14/app/helpers"
)

var (
Expand Down
14 changes: 7 additions & 7 deletions app/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,19 @@ import (
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"

gaiaante "github.com/cosmos/gaia/v13/ante"
"github.com/cosmos/gaia/v13/app/keepers"
gaiaappparams "github.com/cosmos/gaia/v13/app/params"
"github.com/cosmos/gaia/v13/app/upgrades"
v13 "github.com/cosmos/gaia/v13/app/upgrades/v13"
"github.com/cosmos/gaia/v13/x/globalfee"
gaiaante "github.com/cosmos/gaia/v14/ante"
"github.com/cosmos/gaia/v14/app/keepers"
gaiaappparams "github.com/cosmos/gaia/v14/app/params"
"github.com/cosmos/gaia/v14/app/upgrades"
v14 "github.com/cosmos/gaia/v14/app/upgrades/v14"
"github.com/cosmos/gaia/v14/x/globalfee"
)

var (
// DefaultNodeHome default home directories for the application daemon
DefaultNodeHome string

Upgrades = []upgrades.Upgrade{v13.Upgrade}
Upgrades = []upgrades.Upgrade{v14.Upgrade}
)

var (
Expand Down
4 changes: 2 additions & 2 deletions app/app_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import (
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"

gaia "github.com/cosmos/gaia/v13/app"
gaiahelpers "github.com/cosmos/gaia/v13/app/helpers"
gaia "github.com/cosmos/gaia/v14/app"
gaiahelpers "github.com/cosmos/gaia/v14/app/helpers"
)

type EmptyAppOptions struct{}
Expand Down
2 changes: 1 addition & 1 deletion app/encoding.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package gaia
import (
"github.com/cosmos/cosmos-sdk/std"

"github.com/cosmos/gaia/v13/app/params"
"github.com/cosmos/gaia/v14/app/params"
)

// MakeTestEncodingConfig creates an EncodingConfig for testing. This function
Expand Down
2 changes: 1 addition & 1 deletion app/helpers/test_helpers.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import (
banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"

gaiaapp "github.com/cosmos/gaia/v13/app"
gaiaapp "github.com/cosmos/gaia/v14/app"
)

// SimAppChainID hardcoded chainID for simulation
Expand Down
2 changes: 1 addition & 1 deletion app/keepers/keepers.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ import (
upgradekeeper "github.com/cosmos/cosmos-sdk/x/upgrade/keeper"
upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"

"github.com/cosmos/gaia/v13/x/globalfee"
"github.com/cosmos/gaia/v14/x/globalfee"
)

type AppKeepers struct {
Expand Down
4 changes: 2 additions & 2 deletions app/modules.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ import (
upgradeclient "github.com/cosmos/cosmos-sdk/x/upgrade/client"
upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"

gaiaappparams "github.com/cosmos/gaia/v13/app/params"
"github.com/cosmos/gaia/v13/x/globalfee"
gaiaappparams "github.com/cosmos/gaia/v14/app/params"
"github.com/cosmos/gaia/v14/x/globalfee"
)

var maccPerms = map[string][]string{
Expand Down
Loading

0 comments on commit a1ec04e

Please sign in to comment.