Skip to content

Commit

Permalink
docs: update tasks list for release branch (#15025)
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrbrt committed Feb 14, 2023
1 parent 2190974 commit cb23af6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 17 deletions.
9 changes: 7 additions & 2 deletions RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,16 @@ v1.0.0-beta1 → v1.0.0-beta2 → ... → v1.0.0-rc1 → v1.0.0-rc2 → ... →
* **PRs targeting this branch can be merged _only_ when exceptional circumstances arise**
* update the GitHub mergify integration by adding instructions for automatically backporting commits from `main` to the `release/vY` using the `backport/Y` label.
* In the release branch prepare a new version section in the `CHANGELOG.md`
* All links must be link-ified: `$ python ./scripts/linkify_changelog.py 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](https://github.com/cosmos/cosmos-sdk/blob/release/v0.46.x/CHANGELOG.md#previous-versions)).
* 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.
* Remove GitHub workflows that should not be in the release branch (eg: `deploy-docs.yml`).
* Remove GitHub workflows that should not be in the release branch
* `deploy-docs.yml`: must be removed to avoid duplicate documentation deployment.
* `test.yml`: All standalone go module tests should be removed (expect `./simapp`, and `./tests` and SDK tests).
* These packages are tracked and tested directly on main.
* `build.yml`: Only the SDK and SimApp needs to be built on release branches.
* Tooling is tracked and tested directly on main.
* Create a new annotated git tag for a release candidate (eg: `git tag -a v1.1.0-rc1`) in the release branch.
* from this point we unfreeze main.
* the SDK teams collaborate and do their best to run testnets in order to validate the release.
Expand Down
15 changes: 0 additions & 15 deletions scripts/linkify_changelog.py

This file was deleted.

0 comments on commit cb23af6

Please sign in to comment.