From 7d1b266b4f255ec3dddde5d55ab9b2599947d68b Mon Sep 17 00:00:00 2001 From: Yunze Xu Date: Fri, 17 Feb 2023 19:27:29 +0800 Subject: [PATCH 1/2] Describe how to install the candidated wheels --- RELEASE.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 9902cee..99dda19 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -38,11 +38,17 @@ Bump up the version number as follows. If you haven't already done it, [create and publish the GPG key](https://pulsar.apache.org/contribute/create-gpg-keys/) to sign the release artifacts. +Before running the commands in the following sections, make sure the `GPG_TTY` environment variable has been set. + +```bash +export GPG_TTY=$(tty) +``` + ## Upgrade the C++ client dependency During the development, the C++ client dependency might be downloaded from an unofficial release. But when releasing the Python client, the dependency must be downloaded from an official release. You should modify the base url in [dep-url.sh](./build-support/dep-url.sh). -Example: https://github.com/apache/pulsar-client-python/pull/62 +Example: https://github.com/apache/pulsar-client-python/pull/62 ## Cut the candidate release @@ -57,7 +63,7 @@ git add pulsar/__about__.py git commit -m "Bump version to X.Y.0" git push origin branch-X.Y # N starts with 1 -git tag vX.Y.0-candidate-N +git tag -u $USER@apache.org vX.Y.0-candidate-N -m "Release vX.Y.0 candidate N" git push origin vX.Y.0-candidate-N ``` @@ -70,7 +76,7 @@ git add pulsar/__about__.py git commit -m "Bump version to X.Y.Z" git push origin branch-X.Y # N starts with 1 -git tag vX.Y.Z-candidate-N +git tag -u $USER@apache.org vX.Y.Z-candidate-N -m "Release vX.Y.Z candidate N" git push origin vX.Y.Z-candidate-N ``` @@ -100,8 +106,8 @@ Make sure `curl`, `jq`, `unzip`, `gpg`, `shasum` commands are available. Then yo svn co https://dist.apache.org/repos/dist/dev/pulsar pulsar-dist-dev-keys --depth empty cd pulsar-dist-dev-keys svn mkdir pulsar-client-python-X.Y.Z-candidate-N && cd pulsar-client-python-X.Y.Z-candidate-N -# PROJECT_DIR is the directory of the pulsar-client-python repository -$PROJECT_DIR/build-support/stage-release.sh vX.Y.Z-candidate-N $WORKFLOW_ID +# PROJECT_DIR is the directory of the pulsar-client-python repository +$PROJECT_DIR/build-support/stage-release.sh X.Y.Z-candidate-N $WORKFLOW_ID svn add * svn ci -m "Staging artifacts and signature for Python client X.Y.Z-candidate-N" ``` @@ -135,12 +141,17 @@ supported platforms and architectures are: - musl-based Linux arm64 (linux-musl-arm64/) - macOS universal 2 (macos/) +You can download the wheel (the `.whl` file) according to your own OS and Python version +and install the wheel: +- Windows: `py -m pip install *.whl --force-reinstall` +- Linux or macOS: `python3 -m pip install *.whl --force-reinstall` + The tag to be voted upon: vX.Y.Z-candidate-N () https://github.com/apache/pulsar-client-python/releases/tag/vX.Y.Z-candidate-N Pulsar's KEYS file containing PGP keys you use to sign the release: -https://dist.apache.org/repos/dist/dev/pulsar/KEYS +https://dist.apache.org/repos/dist/release/pulsar/KEYS Please download the Python wheels and follow the README to test. ``` @@ -195,7 +206,7 @@ Push the official tag: ```bash git checkout vX.Y.Z-candidate-N -git tag vX.Y.Z +git tag -u $USER@apache.org vX.Y.Z -m "Release vX.Y.Z" git push origin vX.Y.Z ``` From 030ece91cf84acd094b816a08d1479395a357b7d Mon Sep 17 00:00:00 2001 From: Yunze Xu Date: Fri, 17 Feb 2023 23:41:32 +0800 Subject: [PATCH 2/2] Fix the KEYS URL --- RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index 99dda19..a056edb 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -151,7 +151,7 @@ The tag to be voted upon: vX.Y.Z-candidate-N https://github.com/apache/pulsar-client-python/releases/tag/vX.Y.Z-candidate-N Pulsar's KEYS file containing PGP keys you use to sign the release: -https://dist.apache.org/repos/dist/release/pulsar/KEYS +https://downloads.apache.org/pulsar/KEYS Please download the Python wheels and follow the README to test. ```