kafka/release
David Jacot 14ebec345a
MINOR: Update release script for 4.0 (#18999)
This patch updates the release script to use JDK 21 to build the
release. We could also use JDK 17 but using JDK 21 directly does not
change much. We have to verify anyway that the server works with 17 and
the client with 11.

Reviewers: Ismael Juma <ismael@juma.me.uk>
2025-02-21 20:30:33 +01:00
..
README.md KAFKA-17735: release.py must not use home.apache.org (#17421) 2024-10-08 15:42:01 -07:00
git.py KAFKA-16934: Clean up and refactor release.py (#16287) 2024-07-05 13:01:13 +01:00
gpg.py KAFKA-16934: Clean up and refactor release.py (#16287) 2024-07-05 13:01:13 +01:00
notes.py MINOR: Improve release script (#16613) 2024-07-17 16:45:32 +02:00
preferences.py KAFKA-16934: Clean up and refactor release.py (#16287) 2024-07-05 13:01:13 +01:00
release.py MINOR: Update release script for 4.0 (#18999) 2025-02-21 20:30:33 +01:00
requirements.txt KAFKA-16934: Clean up and refactor release.py (#16287) 2024-07-05 13:01:13 +01:00
runtime.py KAFKA-17735: release.py must not use home.apache.org (#17421) 2024-10-08 15:42:01 -07:00
svn.py KAFKA-17735: release.py must not use home.apache.org (#17421) 2024-10-08 15:42:01 -07:00
templates.py MINOR: update release scripts (#18178) 2024-12-14 12:15:20 +08:00
textfiles.py KAFKA-16934: Clean up and refactor release.py (#16287) 2024-07-05 13:01:13 +01:00

README.md

Releasing Apache Kafka

This directory contains the tools used to publish a release.

Requirements

  • python 3.12
  • git
  • gpg 2.4

The full instructions for producing a release are available in https://cwiki.apache.org/confluence/display/KAFKA/Release+Process.

Setup

Create a virtualenv for python, activate it and install dependencies:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Usage

To start a release, first activate the virutalenv, and then run the release script.

source .venv/bin/activate

You'll need to setup PUSH_REMOTE_NAME to refer to the git remote for apache/kafka.

export PUSH_REMOTE_NAME=<value>

It should be the value shown with this command:

git remote -v | grep -w 'github.com' | grep -w 'apache/kafka' | grep -w '(push)' | awk '{print $1}'

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.