From 18198fad6f81cf11894c14b89c036f73a3dfa235 Mon Sep 17 00:00:00 2001 From: Lari Hotari Date: Thu, 1 Aug 2024 22:11:07 +0300 Subject: [PATCH] Add instructions how to register a new version using the script --- contribute/release-note-guide.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/contribute/release-note-guide.md b/contribute/release-note-guide.md index 6b0b7a95a8c2..abe34ad126da 100644 --- a/contribute/release-note-guide.md +++ b/contribute/release-note-guide.md @@ -26,19 +26,29 @@ gh auth login ## Fetch the release metadata ```bash -# Replace v2.10.2 with the target version tag +# Replace 3.0.6 with the target version tag +VERSION_WITHOUT_RC=3.0.6 # Replace apache/pulsar with the component repo -gh release view "v2.10.2" -R apache/pulsar --json author,tagName,publishedAt +gh release view "v$VERSION_WITHOUT_RC" -R apache/pulsar --json author,tagName,publishedAt ``` ## Fetch the release note ```bash -# Replace v2.10.2 with the target version tag +# Replace 3.0.6 with the target version tag +VERSION_WITHOUT_RC=3.0.6 # Replace apache/pulsar with the component repo -gh release view "v2.10.2" -R apache/pulsar --json body --jq .body +gh release view "v$VERSION_WITHOUT_RC" -R apache/pulsar --json body --jq .body ``` +## Register the new released version to releases.json, data/release-pulsar.js and data/release-java.js files + +```bash +# Replace 3.0.6 with the target version tag +VERSION_WITHOUT_RC=3.0.6 +# Replace apache/pulsar with the component repo +./scripts/register_new_version.py $VERSION_WITHOUT_RC $(gh release view "v$VERSION_WITHOUT_RC" -R apache/pulsar --json author,publishedAt | jq -r '[.author.login, .publishedAt] | join(" ")') +``` ## Generate release notes