This is an automated email from the ASF dual-hosted git repository. jlprat pushed a commit to branch 3.8 in repository https://gitbox.apache.org/repos/asf/kafka.git
commit f25ffc0f698b80944eaf4b6de59ce90fc5eae2b2 Author: Josep Prat <[email protected]> AuthorDate: Wed Jul 17 16:45:32 2024 +0200 MINOR: Improve release script (#16613) * MINOR: Improve release script Co-authored-by: Igor Soarez <[email protected]> --------- Signed-off-by: Josep Prat <[email protected]> Co-authored-by: Igor Soarez <[email protected]> Reviewers: Igor Soarez <[email protected]> --- release/README.md | 6 ++++++ release/notes.py | 7 +++---- release/release.py | 4 ++-- release/templates.py | 6 ++++-- 4 files changed, 15 insertions(+), 8 deletions(-) diff --git a/release/README.md b/release/README.md index 0bb75acae03..0222164cd3d 100644 --- a/release/README.md +++ b/release/README.md @@ -52,3 +52,9 @@ Then start the release script: python release.py ``` +Should you encounter some problem, where re-running the script doesn't work, look at the following steps: + +- The script remembers data inputted previously if you need to correct it, it is saved under the +`.release-settings.json` file in the `release` folder. +- If the script is interrupted you might need to manually delete the tag named after the release candidate name and +branch named after the release version. diff --git a/release/notes.py b/release/notes.py index 8097183a2b9..529c27b3728 100644 --- a/release/notes.py +++ b/release/notes.py @@ -132,11 +132,10 @@ def issue_str(issue): """ Provides a human readable string representation for the given issue. """ - key = issue.key - resolution = issue.fields.resolution + key = "%15s" % issue.key + resolution = "%15s" % issue.fields.resolution link = issue_link(issue) - return f"{key:>15} {resolution:>20} {link}" - + return f"{key} {resolution} {link}" def generate(version): """ diff --git a/release/release.py b/release/release.py index 9c74e9f092c..7710789bba8 100644 --- a/release/release.py +++ b/release/release.py @@ -104,7 +104,7 @@ def docs_version(version): return ''.join(major_minor) -def docs_release_version(version): +def detect_docs_release_version(version): """ Detects the version from gradle.properties and converts it to a release version number that should be valid for the current release branch. For example, 0.10.2.0-SNAPSHOT would remain 0.10.2.0-SNAPSHOT (because no release has been @@ -130,7 +130,7 @@ def command_stage_docs(): # We explicitly override the version of the project that we normally get from gradle.properties since we want to be # able to run this from a release branch where we made some updates, but the build would show an incorrect SNAPSHOT # version due to already having bumped the bugfix version number. - gradle_version_override = docs_release_version(project_version) + gradle_version_override = detect_docs_release_version(project_version) cmd("Building docs", f"./gradlew -Pversion={gradle_version_override} clean siteDocsTar aggregatedJavadoc", cwd=repo_dir, env=jdk17_env) diff --git a/release/templates.py b/release/templates.py index c48f917c7d5..7173ea9153d 100644 --- a/release/templates.py +++ b/release/templates.py @@ -210,8 +210,9 @@ https://kafka.apache.org/KEYS https://home.apache.org/~{apache_id}/kafka-{rc_tag}/ <USE docker/README.md FOR STEPS TO CREATE RELEASE CANDIDATE DOCKER IMAGE> -* Docker release artifact to be voted upon(apache/kafka-native is supported from 3.8+ release.): +* Docker release artifacts to be voted upon: apache/kafka:{rc_tag} +apache/kafka-native:{rc_tag} * Maven artifacts to be voted upon: https://repository.apache.org/content/groups/staging/org/apache/kafka/ @@ -234,7 +235,8 @@ System tests: https://jenkins.confluent.io/job/system-test-kafka/job/{dev_branch <USE docker/README.md FOR STEPS TO RUN DOCKER BUILD TEST GITHUB ACTIONS> * Successful Docker Image Github Actions Pipeline for {dev_branch} branch: -Docker Build Test Pipeline: https://github.com/apache/kafka/actions/runs/<RUN_NUMBER> +Docker Build Test Pipeline (JVM): https://github.com/apache/kafka/actions/runs/<RUN_NUMBER> +Docker Build Test Pipeline (Native): https://github.com/apache/kafka/actions/runs/<RUN_NUMBER> /**************************************
