diff --git a/docs/dev/release-management.md b/docs/dev/release-management.md index 3b3ebc36953..e8851eb15c5 100644 --- a/docs/dev/release-management.md +++ b/docs/dev/release-management.md @@ -1,5 +1,7 @@ # Tagging a release +Before tagging a new release, please run the [compatibility e2e test suite](https://github.com/cosmos/ibc-go/actions/workflows/e2e-compatibility.yaml) for the corresponding release line. + ## New major release branch Pre-requisites for creating a release branch for a new major version: @@ -70,17 +72,16 @@ Additionally, for the first point release of a new major or minor release branch - Update the [list of supported release lines in README.md](../../RELEASES.md#releases), if necessary. - Update the [e2e compatibility test matrices](https://github.com/cosmos/ibc-go/tree/main/.github/compatibility-test-matrices): add the tag for the new release and remove any tags that might not be recommended anymore. - Update the manual [e2e `simd`](https://github.com/cosmos/ibc-go/blob/main/.github/workflows/e2e-manual-simd.yaml) test workflow: - - Remove any tags that might not be recommended anymore. - + - Remove any tags that might not be recommended anymore. - Bump ibc-go version in [cosmos/interchain-accounts-demo repository](https://github.com/cosmos/interchain-accounts-demo) and create a tag. -- [ ] Update docs site: - - [ ] If the release is occurring on the main branch, on the latest version, then run `npm run docusaurus docs:version vX.Y.Z` in the `docs/` directory. (where `X.Y.Z` is the new version number) - - [ ] If the release is occurring on an older release branch, then make a PR to the main branch called `docs: new release vX.Y.Z` doing the following: - - [ ] Update the content of the docs found in `docs/versioned_docs/version-vx.y.z` if needed. (where `x.y.z` is the previous version number) - - [ ] Update the version number of the older release branch by changing the version number of the older release branch in: - - [ ] In `docs/versions.json`. - - [ ] Rename `docs/versioned_sidebars/version-vx.y.z-sidebars.json` - - [ ] Rename `docs/versioned_docs/version-vx.y.z` +- Update docs site: + - If the release is occurring on the main branch, on the latest version, then run `npm run docusaurus docs:version vX.Y.Z` in the `docs/` directory. (where `X.Y.Z` is the new version number) + - If the release is occurring on an older release branch, then make a PR to the main branch called `docs: new release vX.Y.Z` doing the following: + - Update the content of the docs found in `docs/versioned_docs/version-vx.y.z` if needed. (where `x.y.z` is the previous version number) + - Update the version number of the older release branch by changing the version number of the older release branch in: + - In `docs/versions.json`. + - Rename `docs/versioned_sidebars/version-vx.y.z-sidebars.json` + - Rename `docs/versioned_docs/version-vx.y.z` - After changes to docs site are deployed, check [ibc.cosmos.network](https://ibc.cosmos.network) is updated. - Open issue in [SDK tutorials repo](https://github.com/cosmos/sdk-tutorials) to update tutorials to the released version of ibc-go.