Skip to content

Commit 9ee23b8

Browse files
authored
Fix the release doc for PyPI login and release note sample PR (#192)
1 parent 81e833d commit 9ee23b8

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

RELEASE.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,8 @@ svn move -m "Release Apache Pulsar Client Python X.Y.Z" \
185185

186186
1. You need to create an account on PyPI: https://pypi.org/account/register/
187187
2. Ask anyone that has been a release manager before to add you as a maintainer for [pulsar-client](https://pypi.org/manage/project/pulsar-client/releases/) on PyPI
188-
3. Once you have completed the following steps in this section, you can check if the wheels are uploaded successfully in Download files. Remember to switch to the correct version in Release history).
188+
3. PyPI has discontinued the use of plain usernames and passwords for login. It is now necessary to generate and obtain an API token for PyPI. Please visit pypi.org, navigate to "Account Settings", then "API tokens" to generate your API token. Remember to copy it.
189+
4. Once you have completed the following steps in this section, you can check if the wheels are uploaded successfully in Download files. Remember to switch to the correct version in Release history.
189190

190191
Then, upload the wheels to PyPI:
191192

@@ -194,6 +195,8 @@ sudo python3 -m pip install twine
194195
./build-support/upload-pypi.sh https://dist.apache.org/repos/dist/release/pulsar/pulsar-client-python-X.Y.Z
195196
```
196197

198+
To sign in to PyPI, please use `__token__` as your username and enter your API token as the password.
199+
197200
To verify the wheels have been uploaded successfully, you can try installing the wheel:
198201

199202
```bash
@@ -212,7 +215,7 @@ git push origin vX.Y.Z
212215

213216
Then, [create a release](https://github.com/apache/pulsar-client-python/releases/new). Choose the `vX.Y.Z` tag and click the `Generate release notes` button to generate the release note automatically. Here is an example release note: https://github.com/apache/pulsar-client-python/releases/tag/v3.0.0
214217

215-
Then, create a PR in [`pulsar-site`](https://github.com/apache/pulsar-site) repo to update the website. Here is an example: https://github.com/apache/pulsar-site/pull/343
218+
Then, create a PR in [`pulsar-site`](https://github.com/apache/pulsar-site) repo to update the website. Here is an example: https://github.com/apache/pulsar-site/pull/761
216219

217220
## Generate the API documents
218221

0 commit comments

Comments
 (0)