Skip to content

Commit 9b3c55f

Browse files
[docs] Describe how to install the candidate wheels (#97)
* Describe how to install the candidated wheels * Fix the KEYS URL
1 parent 2bab367 commit 9b3c55f

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

RELEASE.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,17 @@ Bump up the version number as follows.
3838

3939
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.
4040

41+
Before running the commands in the following sections, make sure the `GPG_TTY` environment variable has been set.
42+
43+
```bash
44+
export GPG_TTY=$(tty)
45+
```
46+
4147
## Upgrade the C++ client dependency
4248

4349
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).
4450

45-
Example: https://github.com/apache/pulsar-client-python/pull/62
51+
Example: https://github.com/apache/pulsar-client-python/pull/62
4652

4753
## Cut the candidate release
4854

@@ -57,7 +63,7 @@ git add pulsar/__about__.py
5763
git commit -m "Bump version to X.Y.0"
5864
git push origin branch-X.Y
5965
# N starts with 1
60-
git tag vX.Y.0-candidate-N
66+
git tag -u $USER@apache.org vX.Y.0-candidate-N -m "Release vX.Y.0 candidate N"
6167
git push origin vX.Y.0-candidate-N
6268
```
6369

@@ -70,7 +76,7 @@ git add pulsar/__about__.py
7076
git commit -m "Bump version to X.Y.Z"
7177
git push origin branch-X.Y
7278
# N starts with 1
73-
git tag vX.Y.Z-candidate-N
79+
git tag -u $USER@apache.org vX.Y.Z-candidate-N -m "Release vX.Y.Z candidate N"
7480
git push origin vX.Y.Z-candidate-N
7581
```
7682

@@ -100,8 +106,8 @@ Make sure `curl`, `jq`, `unzip`, `gpg`, `shasum` commands are available. Then yo
100106
svn co https://dist.apache.org/repos/dist/dev/pulsar pulsar-dist-dev-keys --depth empty
101107
cd pulsar-dist-dev-keys
102108
svn mkdir pulsar-client-python-X.Y.Z-candidate-N && cd pulsar-client-python-X.Y.Z-candidate-N
103-
# PROJECT_DIR is the directory of the pulsar-client-python repository
104-
$PROJECT_DIR/build-support/stage-release.sh vX.Y.Z-candidate-N $WORKFLOW_ID
109+
# PROJECT_DIR is the directory of the pulsar-client-python repository
110+
$PROJECT_DIR/build-support/stage-release.sh X.Y.Z-candidate-N $WORKFLOW_ID
105111
svn add *
106112
svn ci -m "Staging artifacts and signature for Python client X.Y.Z-candidate-N"
107113
```
@@ -135,12 +141,17 @@ supported platforms and architectures are:
135141
- musl-based Linux arm64 (linux-musl-arm64/)
136142
- macOS universal 2 (macos/)
137143
144+
You can download the wheel (the `.whl` file) according to your own OS and Python version
145+
and install the wheel:
146+
- Windows: `py -m pip install *.whl --force-reinstall`
147+
- Linux or macOS: `python3 -m pip install *.whl --force-reinstall`
148+
138149
The tag to be voted upon: vX.Y.Z-candidate-N
139150
(<commit-id>)
140151
https://github.com/apache/pulsar-client-python/releases/tag/vX.Y.Z-candidate-N
141152
142153
Pulsar's KEYS file containing PGP keys you use to sign the release:
143-
https://dist.apache.org/repos/dist/dev/pulsar/KEYS
154+
https://downloads.apache.org/pulsar/KEYS
144155
145156
Please download the Python wheels and follow the README to test.
146157
```
@@ -195,7 +206,7 @@ Push the official tag:
195206

196207
```bash
197208
git checkout vX.Y.Z-candidate-N
198-
git tag vX.Y.Z
209+
git tag -u $USER@apache.org vX.Y.Z -m "Release vX.Y.Z"
199210
git push origin vX.Y.Z
200211
```
201212

0 commit comments

Comments
 (0)