From cb23af6d9731c8e9468b7a9a29bb65042775cfdd Mon Sep 17 00:00:00 2001 From: Julien Robert Date: Tue, 14 Feb 2023 14:40:47 +0100 Subject: [PATCH] docs: update tasks list for release branch (#15025) --- RELEASE_PROCESS.md | 9 +++++++-- scripts/linkify_changelog.py | 15 --------------- 2 files changed, 7 insertions(+), 17 deletions(-) delete mode 100644 scripts/linkify_changelog.py diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md index 4dc3b20624..e02e883982 100644 --- a/RELEASE_PROCESS.md +++ b/RELEASE_PROCESS.md @@ -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. diff --git a/scripts/linkify_changelog.py b/scripts/linkify_changelog.py deleted file mode 100644 index cea22ec6cf..0000000000 --- a/scripts/linkify_changelog.py +++ /dev/null @@ -1,15 +0,0 @@ -import fileinput -import re - -# This script goes through the provided file, and replaces any " \#", -# with the valid mark down formatted link to it. e.g. -# " [\#number](https://github.com/cosmos/cosmos-sdk/issues/) -# Note that if the number is for a PR, github will auto-redirect you when you click the link. -# It is safe to run the script multiple times in succession. -# -# Example: -# -# $ python ./scripts/linkify_changelog.py CHANGELOG.md -for line in fileinput.input(inplace=1): - line = re.sub(r"\s\\#([0-9]+)", r" [\\#\1](https://github.com/cosmos/cosmos-sdk/issues/\1)", line.rstrip()) - print(line) \ No newline at end of file