You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/09/05 08:44:14 UTC
[GitHub] [pulsar] BewareMyPower opened a new pull request, #17470: [doc] Fix the release process and regenerate the table of contents
BewareMyPower opened a new pull request, #17470:
URL: https://github.com/apache/pulsar/pull/17470
### Motivation
There are some wrong steps in the release process and the "Release
workflow" section is just a list and hard to verify directly.
### Modifications
- Remove the "Move master branch to next version" and "Write release
notes" sections because they should be done in the last few steps and
they have already been documented.
- Add the steps to build Docker images when running the vote.
- Skip the release of Helm Chart for patch releases.
- Update the step to publish Python clients for macOS because we won't
need the VirtualBox after https://github.com/apache/pulsar/pull/15024.
Regenerate the table of contents via `gh-md-toc` to replace the "Release
workflow" section. Then we can verify it by clicking the link to the
corresponding section.
### Documentation
Check the box below or label this PR directly.
Need to update docs?
- [ ] `doc-required`
(Your PR needs to update docs and you will update later)
- [ ] `doc-not-needed`
(Please explain why)
- [x] `doc`
(Your PR contains doc changes)
- [ ] `doc-complete`
(Docs have been already added)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Jason918 commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
Jason918 commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r963191890
##########
wiki/release/release-process.md:
##########
@@ -412,35 +421,19 @@ $ twine upload pulsar_client-*.whl
### MacOS
-> **NOTES**
->
-> You need to install following softwares before proceeding:
->
-> - [VirtualBox](https://www.virtualbox.org/)
-> - [VirtualBox Extension Pack]
-> - [Vagrant](https://www.vagrantup.com/)
-> - [Vagrant-scp](https://github.com/invernizzi/vagrant-scp)
->
-> And make sure your laptop have enough disk spaces (> 30GB) since the build scripts
-> will download MacOS images, launch them in VirtualBox and build the python
-> scripts.
-
-Build the python scripts.
+There is a script that builds and packages the Python client inside Docker images.
```shell
-$ cd pulsar-client-cpp/python/pkg/osx/
-$ ./generate-all-wheel.sh v2.X.Y
+$ pulsar-client-cpp/python/build-mac-wheels.sh
```
The wheel files will be generated at each platform directory under `pulsar-client-cpp/python/pkg/osx/`.
Then you can run `twin upload` to upload those wheel files.
-If you don't have enough spaces, you can build the python wheel file platform by platform and remove the images under `~/.vagrant.d/boxes` between each run.
-
-## 13. Publish MacOS libpulsar package
+## 12. Publish MacOS libpulsar package
Review Comment:
@chenrui333 Can you help verify this? since you released past few versions of `libpulsar`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r962997865
##########
wiki/release/release-process.md:
##########
@@ -303,17 +287,41 @@ https://github.com/apache/pulsar/releases/tag/v2.X.0-candidate-1
Pulsar's KEYS file containing PGP keys we use to sign the release:
https://dist.apache.org/repos/dist/dev/pulsar/KEYS
+Docker images:
+
+<link of the pulsar images>
+
+<link of the pulsar-all image>
+
Please download the source package, and follow the README to build
and run the Pulsar standalone service.
```
+> **NOTE**
+>
+> See [here](#9-publish-docker-images) for how to build the docker images. The release manager could push the images to a private account for others to validate.
+
The vote should be open for at least 72 hours (3 days). Votes from Pulsar PMC members
will be considered binding, while anyone else is encouraged to verify the release and
vote as well.
If the release is approved here, we can then proceed to next step.
-## 9. Promote the release
+## 7. Move master branch to next version
+
Review Comment:
I see your comment in step 20. I will update it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r971467410
##########
wiki/release/release-process.md:
##########
@@ -592,10 +549,13 @@ svn ls https://dist.apache.org/repos/dist/release/pulsar
svn rm https://dist.apache.org/repos/dist/release/pulsar/pulsar-2.Y.0
```
-## 21. Move branch to next version
+## Move release branch to next version
-Follow the instructions in step 6, but run the script on the release branch.
+Run the following commands in release branches.
```shell
./src/set-project-version.sh 2.X.Y-SNAPSHOT
+
+git commit -m 'Bumped version to 2.X.Y-SNAPSHOT' -a
Review Comment:
No, we should not. Because `set-project-version.sh` will generate a new temporary file `deployment/terraform-ansible/deploy-pulsar.yaml-e` and unfortunately it's not included in `.gitignore`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Jason918 commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
Jason918 commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r962705654
##########
wiki/release/release-process.md:
##########
@@ -382,13 +391,13 @@ This is alternative to A. when the user has access to apachepulsar org in hub.do
4. Once it is merged, the chart will be automatically released to Github releases at https://github.com/apache/pulsar-helm-chart and updated to https://pulsar.apache.org/charts.
-## 12. Publish Python Clients
+## 11. Publish Python Clients
Review Comment:
It's better to swap step 11 and 12.
##########
wiki/release/release-process.md:
##########
@@ -412,35 +421,19 @@ $ twine upload pulsar_client-*.whl
### MacOS
-> **NOTES**
->
-> You need to install following softwares before proceeding:
->
-> - [VirtualBox](https://www.virtualbox.org/)
-> - [VirtualBox Extension Pack]
-> - [Vagrant](https://www.vagrantup.com/)
-> - [Vagrant-scp](https://github.com/invernizzi/vagrant-scp)
->
-> And make sure your laptop have enough disk spaces (> 30GB) since the build scripts
-> will download MacOS images, launch them in VirtualBox and build the python
-> scripts.
-
-Build the python scripts.
+There is a script that builds and packages the Python client inside Docker images.
```shell
-$ cd pulsar-client-cpp/python/pkg/osx/
-$ ./generate-all-wheel.sh v2.X.Y
+$ pulsar-client-cpp/python/build-mac-wheels.sh
```
The wheel files will be generated at each platform directory under `pulsar-client-cpp/python/pkg/osx/`.
Then you can run `twin upload` to upload those wheel files.
-If you don't have enough spaces, you can build the python wheel file platform by platform and remove the images under `~/.vagrant.d/boxes` between each run.
-
-## 13. Publish MacOS libpulsar package
+## 12. Publish MacOS libpulsar package
Review Comment:
This is similar with Helm Chart, it can be skipped if the major version number is not latest.
##########
wiki/release/release-process.md:
##########
@@ -467,11 +460,18 @@ cp pulsar-broker/target/docs/*.json site2/website/static/swagger/2.X.0
```
Send out a PR request for review.
-## 16. Write release notes
+## 15. Write release notes
+
+Check the milestone in Github associated with the release.
+https://github.com/apache/pulsar/milestones?closed=1
+
+In the release item, add the list of most important changes that happened in the
+release and a link to the associated milestone, with the complete list of all the
+changes.
Review Comment:
I think we should just remove this part. There is no release item in the link.
##########
wiki/release/release-process.md:
##########
@@ -333,7 +341,7 @@ select the staging repository associated with the RC candidate that was approved
will be like `orgapachepulsar-XYZ`. Select the repository and click on "Release". Artifacts
will now be made available on Maven central.
-## 10. Publish Docker Images
+## 9. Publish Docker Images
Review Comment:
Maybe we should add the list of committer with access to apachepulsar org?
##########
wiki/release/release-process.md:
##########
@@ -303,17 +287,41 @@ https://github.com/apache/pulsar/releases/tag/v2.X.0-candidate-1
Pulsar's KEYS file containing PGP keys we use to sign the release:
https://dist.apache.org/repos/dist/dev/pulsar/KEYS
+Docker images:
Review Comment:
If we add this part. Let's move the first part of 9.A forward, before this Vote. And remove 9.B.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Jason918 commented on pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
Jason918 commented on PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#issuecomment-1237589715
@BewareMyPower This is a great improvement. I think we can send a discuss to mail-list to draw more attentions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#issuecomment-1237703268
I have changed a lot based on the previous changes, PTAL again @Jason918 @tisonkun
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] momo-jun commented on a diff in pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r971582329
##########
wiki/release/release-process.md:
##########
@@ -311,9 +306,25 @@ The vote should be open for at least 72 hours (3 days). Votes from Pulsar PMC me
will be considered binding, while anyone else is encouraged to verify the release and
vote as well.
-If the release is approved here, we can then proceed to next step.
+If the release is approved here, we can then proceed to next step. Otherwise, we should repeat the previous steps and prepare another candidate release to vote.
Review Comment:
```suggestion
If the release is approved here, we can then proceed to the next step. Otherwise, you should repeat the previous steps and prepare another candidate release to vote.
```
Better keep the pronoun consistent and use the second-person pronoun throughout the guide. It can also be omitted in step-by-step instructions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r963289514
##########
wiki/release/release-process.md:
##########
@@ -19,42 +19,48 @@
-->
-# Release Process
+* [Release Process](#release-process)
+ * [1. Create the release branch](#1-create-the-release-branch)
+ * [2. Update project version and tag](#2-update-project-version-and-tag)
+ * [3. Build and inspect the artifacts](#3-build-and-inspect-the-artifacts)
+ * [3.1. Build RPM and DEB packages](#31-build-rpm-and-deb-packages)
+ * [4. Sign and stage the artifacts](#4-sign-and-stage-the-artifacts)
+ * [5. Stage artifacts in maven](#5-stage-artifacts-in-maven)
+ * [6. Run the vote](#6-run-the-vote)
+ * [7. Move master branch to next version](#7-move-master-branch-to-next-version)
+ * [8. Promote the release](#8-promote-the-release)
+ * [9. Publish Docker Images](#9-publish-docker-images)
+ * [A. No push access to apachepulsar org - use Personal account for staging the Docker images](#a-no-push-access-to-apachepulsar-org---use-personal-account-for-staging-the-docker-images)
+ * [Publish Docker Images to personal account in hub.docker.com (if you don't have access to apachepulsar org)](#publish-docker-images-to-personal-account-in-hubdockercom-if-you-dont-have-access-to-apachepulsar-org)
+ * [Copy Docker image from the Release manager's personal account to apachepulsar org](#copy-docker-image-from-the-release-managers-personal-account-to-apachepulsar-org)
+ * [B. Push access to apachepulsar org](#b-push-access-to-apachepulsar-org)
+ * [Publish Docker Images directly to apachepulsar org in hub.docker.com](#publish-docker-images-directly-to-apachepulsar-org-in-hubdockercom)
+ * [10. Release Helm Chart](#10-release-helm-chart)
+ * [11. Publish Python Clients](#11-publish-python-clients)
+ * [Linux](#linux)
+ * [MacOS](#macos)
+ * [12. Publish MacOS libpulsar package](#12-publish-macos-libpulsar-package)
+ * [13. Update Python Client docs](#13-update-python-client-docs)
+ * [14. Update swagger file](#14-update-swagger-file)
+ * [15. Write release notes](#15-write-release-notes)
+ * [16. Update the site](#16-update-the-site)
+ * [Update the site for major releases](#update-the-site-for-major-releases)
+ * [Update the site for minor releases](#update-the-site-for-minor-releases)
+ * [17. Announce the release](#17-announce-the-release)
+ * [18. Write a blog post for the release (optional)](#18-write-a-blog-post-for-the-release-optional)
+ * [19. Remove old releases](#19-remove-old-releases)
+ * [20. Move release branch to next version](#20-move-release-branch-to-next-version)
+
Review Comment:
It makes sense. I think we can remove the number as well. Otherwise, when you insert a section, you have to change all subsequent section numbers.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r963211494
##########
wiki/release/release-process.md:
##########
@@ -412,35 +421,19 @@ $ twine upload pulsar_client-*.whl
### MacOS
-> **NOTES**
->
-> You need to install following softwares before proceeding:
->
-> - [VirtualBox](https://www.virtualbox.org/)
-> - [VirtualBox Extension Pack]
-> - [Vagrant](https://www.vagrantup.com/)
-> - [Vagrant-scp](https://github.com/invernizzi/vagrant-scp)
->
-> And make sure your laptop have enough disk spaces (> 30GB) since the build scripts
-> will download MacOS images, launch them in VirtualBox and build the python
-> scripts.
-
-Build the python scripts.
+There is a script that builds and packages the Python client inside Docker images.
```shell
-$ cd pulsar-client-cpp/python/pkg/osx/
-$ ./generate-all-wheel.sh v2.X.Y
+$ pulsar-client-cpp/python/build-mac-wheels.sh
```
The wheel files will be generated at each platform directory under `pulsar-client-cpp/python/pkg/osx/`.
Then you can run `twin upload` to upload those wheel files.
-If you don't have enough spaces, you can build the python wheel file platform by platform and remove the images under `~/.vagrant.d/boxes` between each run.
-
-## 13. Publish MacOS libpulsar package
+## 12. Publish MacOS libpulsar package
Review Comment:
Oh I see. I thought it's similar with `pip`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r962994862
##########
wiki/release/release-process.md:
##########
@@ -467,11 +460,18 @@ cp pulsar-broker/target/docs/*.json site2/website/static/swagger/2.X.0
```
Send out a PR request for review.
-## 16. Write release notes
+## 15. Write release notes
+
+Check the milestone in Github associated with the release.
+https://github.com/apache/pulsar/milestones?closed=1
+
+In the release item, add the list of most important changes that happened in the
+release and a link to the associated milestone, with the complete list of all the
+changes.
Review Comment:
+1. I'll remove them
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Jason918 commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
Jason918 commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r963195502
##########
wiki/release/release-process.md:
##########
@@ -303,17 +287,41 @@ https://github.com/apache/pulsar/releases/tag/v2.X.0-candidate-1
Pulsar's KEYS file containing PGP keys we use to sign the release:
https://dist.apache.org/repos/dist/dev/pulsar/KEYS
+Docker images:
Review Comment:
So I refers to "the first part of 9.A". We can split step 9 to "Publish release candidate docker image" and "Publish docker image".
Referring to a step forward make the process kind of out-of-order.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#issuecomment-1247951900
Thanks for your comments @momo-jun, they're addressed now.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] momo-jun commented on a diff in pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r971583315
##########
wiki/release/release-process.md:
##########
@@ -333,23 +344,11 @@ select the staging repository associated with the RC candidate that was approved
will be like `orgapachepulsar-XYZ`. Select the repository and click on "Release". Artifacts
will now be made available on Maven central.
-## 10. Publish Docker Images
+## Publish Docker Images
-Choose either A. or B. depending if you have access to apachepulsar org in hub.docker.com. There's a limited number of users that are allowed in the account.
+Copy the approved candidate docker images from your personal acccount to apachepulsar org.
Review Comment:
```suggestion
Copy the approved candidate docker images from your personal account to apachepulsar org.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r962990330
##########
wiki/release/release-process.md:
##########
@@ -303,17 +287,41 @@ https://github.com/apache/pulsar/releases/tag/v2.X.0-candidate-1
Pulsar's KEYS file containing PGP keys we use to sign the release:
https://dist.apache.org/repos/dist/dev/pulsar/KEYS
+Docker images:
+
+<link of the pulsar images>
+
+<link of the pulsar-all image>
+
Please download the source package, and follow the README to build
and run the Pulsar standalone service.
```
+> **NOTE**
+>
+> See [here](#9-publish-docker-images) for how to build the docker images. The release manager could push the images to a private account for others to validate.
+
The vote should be open for at least 72 hours (3 days). Votes from Pulsar PMC members
will be considered binding, while anyone else is encouraged to verify the release and
vote as well.
If the release is approved here, we can then proceed to next step.
-## 9. Promote the release
+## 7. Move master branch to next version
+
Review Comment:
No. It's also required for release branches. I found it's duplicated with `20. Move branch to next version`. I will remove this part.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r962994184
##########
wiki/release/release-process.md:
##########
@@ -382,13 +391,13 @@ This is alternative to A. when the user has access to apachepulsar org in hub.do
4. Once it is merged, the chart will be automatically released to Github releases at https://github.com/apache/pulsar-helm-chart and updated to https://pulsar.apache.org/charts.
-## 12. Publish Python Clients
+## 11. Publish Python Clients
Review Comment:
The release scripts of the Python client and the C++ client are independent, though the Python client reuses much C++ client code. I think the order of them is not an issue.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Jason918 commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
Jason918 commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r962723873
##########
wiki/release/release-process.md:
##########
@@ -592,10 +592,14 @@ svn ls https://dist.apache.org/repos/dist/release/pulsar
svn rm https://dist.apache.org/repos/dist/release/pulsar/pulsar-2.Y.0
```
-## 21. Move branch to next version
+## 20. Move branch to next version
Review Comment:
```suggestion
## 20. Move release branch to next version
```
##########
wiki/release/release-process.md:
##########
@@ -592,10 +592,14 @@ svn ls https://dist.apache.org/repos/dist/release/pulsar
svn rm https://dist.apache.org/repos/dist/release/pulsar/pulsar-2.Y.0
```
-## 21. Move branch to next version
+## 20. Move branch to next version
-Follow the instructions in step 6, but run the script on the release branch.
+Run the following commands in release branches.
```shell
./src/set-project-version.sh 2.X.Y-SNAPSHOT
-```
\ No newline at end of file
+
+git commit -m 'Bumped version to 2.Y.0-SNAPSHOT' -a
+```
+
+For major releases, we need to create a Pull Request on GitHub. For patch releases, we can push the commit directly to the release branch.
Review Comment:
Major release version is done in Step 7.
##########
wiki/release/release-process.md:
##########
@@ -303,17 +287,41 @@ https://github.com/apache/pulsar/releases/tag/v2.X.0-candidate-1
Pulsar's KEYS file containing PGP keys we use to sign the release:
https://dist.apache.org/repos/dist/dev/pulsar/KEYS
+Docker images:
+
+<link of the pulsar images>
+
+<link of the pulsar-all image>
+
Please download the source package, and follow the README to build
and run the Pulsar standalone service.
```
+> **NOTE**
+>
+> See [here](#9-publish-docker-images) for how to build the docker images. The release manager could push the images to a private account for others to validate.
+
The vote should be open for at least 72 hours (3 days). Votes from Pulsar PMC members
will be considered binding, while anyone else is encouraged to verify the release and
vote as well.
If the release is approved here, we can then proceed to next step.
-## 9. Promote the release
+## 7. Move master branch to next version
+
Review Comment:
We can add note : this is only for major release only.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#issuecomment-1245488894
I will continue the release process of 2.8.4 from tomorrow and update this PR as well.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tisonkun commented on a diff in pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r971440670
##########
wiki/release/release-process.md:
##########
@@ -175,7 +147,7 @@ This will leave the RPM/YUM and DEB repo files in `pulsar-client-cpp/pkg/rpm/RPM
> Tips: If you get error `c++: internal compiler error: Killed (program cc1plus)` when run `pulsar-client-cpp/pkg/deb/docker-build-deb.sh`. You may need to expand your docker memory greater than 2GB.
Review Comment:
```suggestion
> **NOTE**: If you get error `c++: internal compiler error: Killed (program cc1plus)` when run `pulsar-client-cpp/pkg/deb/docker-build-deb.sh`. You may need to expand your docker memory greater than 2GB.
```
We can use `NOTE` consistently.
##########
wiki/release/release-process.md:
##########
@@ -467,11 +424,11 @@ cp pulsar-broker/target/docs/*.json site2/website/static/swagger/2.X.0
```
Send out a PR request for review.
-## 16. Write release notes
+## Write release notes
-Steps and examples see [Pulsar Release Notes Guide](https://docs.google.com/document/d/1cwNkBefKyV6OPbEXnUrcCdVZi0i2BezqL6vAL7VqVC0/edit#).
+See [Pulsar Release Notes Guide](https://docs.google.com/document/d/1cwNkBefKyV6OPbEXnUrcCdVZi0i2BezqL6vAL7VqVC0/edit#).
Review Comment:
I hope we can inline this guide instead of holding a dangling Google Docs page. But it can be a follow-up.
##########
wiki/release/release-process.md:
##########
@@ -592,10 +549,13 @@ svn ls https://dist.apache.org/repos/dist/release/pulsar
svn rm https://dist.apache.org/repos/dist/release/pulsar/pulsar-2.Y.0
```
-## 21. Move branch to next version
+## Move release branch to next version
-Follow the instructions in step 6, but run the script on the release branch.
+Run the following commands in release branches.
```shell
./src/set-project-version.sh 2.X.Y-SNAPSHOT
+
+git commit -m 'Bumped version to 2.X.Y-SNAPSHOT' -a
Review Comment:
```suggestion
git add .
git commit -s -m 'Bumped version to 2.X.Y-SNAPSHOT'
```
In case of the files aren't tracked yet.
##########
wiki/release/release-process.md:
##########
@@ -452,7 +403,13 @@ Note that it builds the docs within a docker image, so you'll need to have docke
Once the docs are generated, you can add them and submit them in a PR. The expected doc output is `site2/website/static/api/python`.
-## 15. Update swagger file
+## Publish MacOS libpulsar package
+
+**This step can be skipped if the major version number is not latest.**
+
+Release a new version of libpulsar for MacOS, You can follow the example [here](https://github.com/Homebrew/homebrew-core/pull/53514)
Review Comment:
```suggestion
Release a new version of libpulsar on Homebrew, You can follow the example [here](https://github.com/Homebrew/homebrew-core/pull/53514).
```
##########
wiki/release/release-process.md:
##########
@@ -311,9 +284,25 @@ The vote should be open for at least 72 hours (3 days). Votes from Pulsar PMC me
will be considered binding, while anyone else is encouraged to verify the release and
vote as well.
-If the release is approved here, we can then proceed to next step.
+If the release is approved here, we can then proceed to next step. Otherwise, we should repeat the previous steps and prepare another candidate release to vote.
+
+## Move master branch to next version
+
+NOTE: This is for major releases only.
Review Comment:
```suggestion
> **NOTE**: This is for major releases only.
```
Consistent format.
##########
wiki/release/release-process.md:
##########
@@ -242,31 +216,24 @@ minutes. Once complete click "Refresh" and now a link to the staging repository
should be available, something like
https://repository.apache.org/content/repositories/orgapachepulsar-XYZ
+## Publish release candidate docker images
-## 6. Move master branch to next version
-
-We need to move master version to next iteration `X + 1`.
-
-```
-git checkout master
-./src/set-project-version.sh 2.Y.0-SNAPSHOT
+Run the following commands.
Review Comment:
```suggestion
Run the following commands:
```
##########
wiki/release/release-process.md:
##########
@@ -382,13 +352,13 @@ This is alternative to A. when the user has access to apachepulsar org in hub.do
4. Once it is merged, the chart will be automatically released to Github releases at https://github.com/apache/pulsar-helm-chart and updated to https://pulsar.apache.org/charts.
-## 12. Publish Python Clients
+## Publish Python Clients
> **NOTES**
>
> 1. You need to create an account on PyPI: https://pypi.org/project/pulsar-client/
Review Comment:
```suggestion
> 1. You need to create an account on PyPI: https://pypi.org/account/register/
```
##########
wiki/release/release-process.md:
##########
@@ -452,7 +403,13 @@ Note that it builds the docs within a docker image, so you'll need to have docke
Once the docs are generated, you can add them and submit them in a PR. The expected doc output is `site2/website/static/api/python`.
-## 15. Update swagger file
+## Publish MacOS libpulsar package
Review Comment:
```suggestion
## Publish Homebrew libpulsar package
```
It's actually a Homebrew formula and can be used even in Linux OS.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r971479435
##########
wiki/release/release-process.md:
##########
@@ -467,11 +424,11 @@ cp pulsar-broker/target/docs/*.json site2/website/static/swagger/2.X.0
```
Send out a PR request for review.
-## 16. Write release notes
+## Write release notes
-Steps and examples see [Pulsar Release Notes Guide](https://docs.google.com/document/d/1cwNkBefKyV6OPbEXnUrcCdVZi0i2BezqL6vAL7VqVC0/edit#).
+See [Pulsar Release Notes Guide](https://docs.google.com/document/d/1cwNkBefKyV6OPbEXnUrcCdVZi0i2BezqL6vAL7VqVC0/edit#).
Review Comment:
I agree. Actually I'm opposed to referencing an evolving document in the repo. Especially it's not a huge document. We usually use an external link when the content is huge, like the [Pulsar's transaction design](https://github.com/apache/pulsar/wiki/PIP-31%3A-Transaction-Support).
/cc @Anonymitaet
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower merged pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
BewareMyPower merged PR #17470:
URL: https://github.com/apache/pulsar/pull/17470
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r962991826
##########
wiki/release/release-process.md:
##########
@@ -333,7 +341,7 @@ select the staging repository associated with the RC candidate that was approved
will be like `orgapachepulsar-XYZ`. Select the repository and click on "Release". Artifacts
will now be made available on Maven central.
-## 10. Publish Docker Images
+## 9. Publish Docker Images
Review Comment:
I don't know where can I found these committers. Could you provide any help here? @codelipenghui
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#issuecomment-1237195882
@Jason918 I've updated the documents. PTAL again.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r962993134
##########
wiki/release/release-process.md:
##########
@@ -412,35 +421,19 @@ $ twine upload pulsar_client-*.whl
### MacOS
-> **NOTES**
->
-> You need to install following softwares before proceeding:
->
-> - [VirtualBox](https://www.virtualbox.org/)
-> - [VirtualBox Extension Pack]
-> - [Vagrant](https://www.vagrantup.com/)
-> - [Vagrant-scp](https://github.com/invernizzi/vagrant-scp)
->
-> And make sure your laptop have enough disk spaces (> 30GB) since the build scripts
-> will download MacOS images, launch them in VirtualBox and build the python
-> scripts.
-
-Build the python scripts.
+There is a script that builds and packages the Python client inside Docker images.
```shell
-$ cd pulsar-client-cpp/python/pkg/osx/
-$ ./generate-all-wheel.sh v2.X.Y
+$ pulsar-client-cpp/python/build-mac-wheels.sh
```
The wheel files will be generated at each platform directory under `pulsar-client-cpp/python/pkg/osx/`.
Then you can run `twin upload` to upload those wheel files.
-If you don't have enough spaces, you can build the python wheel file platform by platform and remove the images under `~/.vagrant.d/boxes` between each run.
-
-## 13. Publish MacOS libpulsar package
+## 12. Publish MacOS libpulsar package
Review Comment:
Why? libpulsar in Homebrew could have multiple versions at the same time, but there is only one latest version in the charts repo.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Jason918 commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
Jason918 commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r963193258
##########
wiki/release/release-process.md:
##########
@@ -382,13 +391,13 @@ This is alternative to A. when the user has access to apachepulsar org in hub.do
4. Once it is merged, the chart will be automatically released to Github releases at https://github.com/apache/pulsar-helm-chart and updated to https://pulsar.apache.org/charts.
-## 12. Publish Python Clients
+## 11. Publish Python Clients
Review Comment:
I mean swap [11. Publish Python Clients] and [12. Publish MacOS libpulsar package]
So that [13. Update Python Client docs] goes right after "Publish Python Clients"
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#issuecomment-1237604484
@Jason918 Good suggestion. I have sent an email just now.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] momo-jun commented on a diff in pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r971584692
##########
wiki/release/release-process.md:
##########
@@ -452,7 +427,13 @@ Note that it builds the docs within a docker image, so you'll need to have docke
Once the docs are generated, you can add them and submit them in a PR. The expected doc output is `site2/website/static/api/python`.
-## 15. Update swagger file
+## Publish Homebrew libpulsar package
+
+**This step can be skipped if the major version number is not latest.**
+
+Release a new version of libpulsar for Homebrew, You can follow the example [here](https://github.com/Homebrew/homebrew-core/pull/53514)
Review Comment:
```suggestion
Release a new version of libpulsar for Homebrew, You can follow the example [here](https://github.com/Homebrew/homebrew-core/pull/53514).
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] momo-jun commented on a diff in pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r971577472
##########
wiki/release/release-process.md:
##########
@@ -21,41 +21,35 @@
# Release Process
-
This page contains instructions for Pulsar committers on how to perform a release.
+## Preparation
+
+You should open an discussion in dev@apache.org to notify others that you volunteer to be a release manager. If there are no disagreements, you can start the release process.
+
+For major releases, you should create a new branch named `branch-2.X.0` once all PRs with the 2.X.0 milestone are merged. If some PRs with 2.X.0 milestome are still working in progress and might took much time to complete, you can move it to the next milestone if they are not important. In this case, you'd better to notify the author in the PR.
Review Comment:
```suggestion
For major releases, you should create a new branch named `branch-2.X.0` once all PRs with the 2.X.0 milestone are merged. If some PRs with the 2.X.0 milestone are still working in progress and might took much time to complete, you can move them to the next milestone if they are not important. In this case, you'd better notify the author in the PR.
```
##########
wiki/release/release-process.md:
##########
@@ -21,41 +21,35 @@
# Release Process
-
This page contains instructions for Pulsar committers on how to perform a release.
+## Preparation
+
+You should open an discussion in dev@apache.org to notify others that you volunteer to be a release manager. If there are no disagreements, you can start the release process.
+
+For major releases, you should create a new branch named `branch-2.X.0` once all PRs with the 2.X.0 milestone are merged. If some PRs with 2.X.0 milestome are still working in progress and might took much time to complete, you can move it to the next milestone if they are not important. In this case, you'd better to notify the author in the PR.
+
+For minor releases, if there are no disagreements, you should cherry-pick all merged PRs with the `release/X.Y.Z` labels into branch-X.Y. After these PRs are cherry-picked, you should add the `cherry-picked/branch-X.Y` labels.
+
+Sometimes some PRs cannot be cherry-picked cleanly, you might need to create a separated PR and move the `release/X.Y.Z` label from the original PR to it. In this case, you can ask the author to help creating the new PR.
Review Comment:
```suggestion
Sometimes some PRs cannot be cherry-picked cleanly, you might need to create a separate PR and move the `release/X.Y.Z` label from the original PR to it. In this case, you can ask the author to help create the new PR.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r962988089
##########
wiki/release/release-process.md:
##########
@@ -303,17 +287,41 @@ https://github.com/apache/pulsar/releases/tag/v2.X.0-candidate-1
Pulsar's KEYS file containing PGP keys we use to sign the release:
https://dist.apache.org/repos/dist/dev/pulsar/KEYS
+Docker images:
Review Comment:
I have linked `#9-publish-docker-images` in the NOTE below. There is no need to move 9.A here, because we only need to build the images and push them to the private account here. But 9.A include one more step:
> Ask a person with access to apachepulsar org in [hub.docker.com](http://hub.docker.com/) to copy the docker images from your (release manager) personal acccount to apachepulsar org.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r962995720
##########
wiki/release/release-process.md:
##########
@@ -592,10 +592,14 @@ svn ls https://dist.apache.org/repos/dist/release/pulsar
svn rm https://dist.apache.org/repos/dist/release/pulsar/pulsar-2.Y.0
```
-## 21. Move branch to next version
+## 20. Move branch to next version
-Follow the instructions in step 6, but run the script on the release branch.
+Run the following commands in release branches.
```shell
./src/set-project-version.sh 2.X.Y-SNAPSHOT
-```
\ No newline at end of file
+
+git commit -m 'Bumped version to 2.Y.0-SNAPSHOT' -a
+```
+
+For major releases, we need to create a Pull Request on GitHub. For patch releases, we can push the commit directly to the release branch.
Review Comment:
Got it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tisonkun commented on a diff in pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r971467762
##########
wiki/release/release-process.md:
##########
@@ -592,10 +549,13 @@ svn ls https://dist.apache.org/repos/dist/release/pulsar
svn rm https://dist.apache.org/repos/dist/release/pulsar/pulsar-2.Y.0
```
-## 21. Move branch to next version
+## Move release branch to next version
-Follow the instructions in step 6, but run the script on the release branch.
+Run the following commands in release branches.
```shell
./src/set-project-version.sh 2.X.Y-SNAPSHOT
+
+git commit -m 'Bumped version to 2.X.Y-SNAPSHOT' -a
Review Comment:
I think we should add them to `.gitignor` instead, lol. But fair enough to keep as is.
##########
wiki/release/release-process.md:
##########
@@ -592,10 +549,13 @@ svn ls https://dist.apache.org/repos/dist/release/pulsar
svn rm https://dist.apache.org/repos/dist/release/pulsar/pulsar-2.Y.0
```
-## 21. Move branch to next version
+## Move release branch to next version
-Follow the instructions in step 6, but run the script on the release branch.
+Run the following commands in release branches.
```shell
./src/set-project-version.sh 2.X.Y-SNAPSHOT
+
+git commit -m 'Bumped version to 2.X.Y-SNAPSHOT' -a
Review Comment:
I think we should add them to `.gitignore` instead, lol. But fair enough to keep as is.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] momo-jun commented on a diff in pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r971582685
##########
wiki/release/release-process.md:
##########
@@ -311,9 +306,25 @@ The vote should be open for at least 72 hours (3 days). Votes from Pulsar PMC me
will be considered binding, while anyone else is encouraged to verify the release and
vote as well.
-If the release is approved here, we can then proceed to next step.
+If the release is approved here, we can then proceed to next step. Otherwise, we should repeat the previous steps and prepare another candidate release to vote.
+
+## Move master branch to next version
+
+> **NOTE**: This is for major releases only.
+
+We need to move master version to the next iteration `Y` (`X + 1`).
+
+```shell
+git checkout master
+./src/set-project-version.sh 2.Y.0-SNAPSHOT
+
+git commit -m 'Bumped version to 2.Y.0-SNAPSHOT' -a
+```
+
+Since this needs to be merged in `master`, we need to follow the regular process
Review Comment:
```suggestion
Since this needs to be merged into `master`, you need to follow the regular process
```
##########
wiki/release/release-process.md:
##########
@@ -311,9 +306,25 @@ The vote should be open for at least 72 hours (3 days). Votes from Pulsar PMC me
will be considered binding, while anyone else is encouraged to verify the release and
vote as well.
-If the release is approved here, we can then proceed to next step.
+If the release is approved here, we can then proceed to next step. Otherwise, we should repeat the previous steps and prepare another candidate release to vote.
+
+## Move master branch to next version
+
+> **NOTE**: This is for major releases only.
+
+We need to move master version to the next iteration `Y` (`X + 1`).
+
+```shell
+git checkout master
+./src/set-project-version.sh 2.Y.0-SNAPSHOT
+
+git commit -m 'Bumped version to 2.Y.0-SNAPSHOT' -a
+```
+
+Since this needs to be merged in `master`, we need to follow the regular process
+and create a Pull Request on github.
Review Comment:
```suggestion
and create a Pull Request on GitHub.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] momo-jun commented on a diff in pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r971577472
##########
wiki/release/release-process.md:
##########
@@ -21,41 +21,35 @@
# Release Process
-
This page contains instructions for Pulsar committers on how to perform a release.
+## Preparation
+
+You should open an discussion in dev@apache.org to notify others that you volunteer to be a release manager. If there are no disagreements, you can start the release process.
+
+For major releases, you should create a new branch named `branch-2.X.0` once all PRs with the 2.X.0 milestone are merged. If some PRs with 2.X.0 milestome are still working in progress and might took much time to complete, you can move it to the next milestone if they are not important. In this case, you'd better to notify the author in the PR.
Review Comment:
```suggestion
For major releases, you should create a new branch named `branch-2.X.0` once all PRs with the 2.X.0 milestone are merged. If some PRs with the 2.X.0 milestone are still working in progress and might take much time to complete, you can move them to the next milestone if they are not important. In this case, you'd better notify the author in the PR.
```
##########
wiki/release/release-process.md:
##########
@@ -21,41 +21,35 @@
# Release Process
-
This page contains instructions for Pulsar committers on how to perform a release.
+## Preparation
+
+You should open an discussion in dev@apache.org to notify others that you volunteer to be a release manager. If there are no disagreements, you can start the release process.
Review Comment:
```suggestion
Open a discussion in dev@apache.org to notify others that you volunteer to be the release manager of a specific release. If there are no disagreements, you can start the release process.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] momo-jun commented on a diff in pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r971578610
##########
wiki/release/release-process.md:
##########
@@ -21,41 +21,35 @@
# Release Process
-
This page contains instructions for Pulsar committers on how to perform a release.
+## Preparation
+
+You should open an discussion in dev@apache.org to notify others that you volunteer to be a release manager. If there are no disagreements, you can start the release process.
+
+For major releases, you should create a new branch named `branch-2.X.0` once all PRs with the 2.X.0 milestone are merged. If some PRs with 2.X.0 milestome are still working in progress and might took much time to complete, you can move it to the next milestone if they are not important. In this case, you'd better to notify the author in the PR.
+
+For minor releases, if there are no disagreements, you should cherry-pick all merged PRs with the `release/X.Y.Z` labels into branch-X.Y. After these PRs are cherry-picked, you should add the `cherry-picked/branch-X.Y` labels.
+
+Sometimes some PRs cannot be cherry-picked cleanly, you might need to create a separated PR and move the `release/X.Y.Z` label from the original PR to it. In this case, you can ask the author to help creating the new PR.
+
+For PRs that are still open, you can choose delaying them to the next release or pinging others to review so that they can be merged.
Review Comment:
```suggestion
For PRs that are still open, you can choose to delay them to the next release or ping others to review so that they can be merged.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r971476391
##########
wiki/release/release-process.md:
##########
@@ -592,10 +549,13 @@ svn ls https://dist.apache.org/repos/dist/release/pulsar
svn rm https://dist.apache.org/repos/dist/release/pulsar/pulsar-2.Y.0
```
-## 21. Move branch to next version
+## Move release branch to next version
-Follow the instructions in step 6, but run the script on the release branch.
+Run the following commands in release branches.
```shell
./src/set-project-version.sh 2.X.Y-SNAPSHOT
+
+git commit -m 'Bumped version to 2.X.Y-SNAPSHOT' -a
Review Comment:
Yes, we should.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a diff in pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r971480774
##########
wiki/release/release-process.md:
##########
@@ -382,13 +352,13 @@ This is alternative to A. when the user has access to apachepulsar org in hub.do
4. Once it is merged, the chart will be automatically released to Github releases at https://github.com/apache/pulsar-helm-chart and updated to https://pulsar.apache.org/charts.
-## 12. Publish Python Clients
+## Publish Python Clients
> **NOTES**
>
> 1. You need to create an account on PyPI: https://pypi.org/project/pulsar-client/
Review Comment:
Yes. In addition, the original link shows where the wheels are uploaded, I will add another line to explain it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on pull request #17470: [doc] Fix the release process
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#issuecomment-1247544106
@michaeljmarshall @Jason918 I have also adopted your suggestions in the email, see the new **Preparation** section.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tisonkun commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r963277120
##########
wiki/release/release-process.md:
##########
@@ -19,42 +19,48 @@
-->
-# Release Process
+* [Release Process](#release-process)
+ * [1. Create the release branch](#1-create-the-release-branch)
+ * [2. Update project version and tag](#2-update-project-version-and-tag)
+ * [3. Build and inspect the artifacts](#3-build-and-inspect-the-artifacts)
+ * [3.1. Build RPM and DEB packages](#31-build-rpm-and-deb-packages)
+ * [4. Sign and stage the artifacts](#4-sign-and-stage-the-artifacts)
+ * [5. Stage artifacts in maven](#5-stage-artifacts-in-maven)
+ * [6. Run the vote](#6-run-the-vote)
+ * [7. Move master branch to next version](#7-move-master-branch-to-next-version)
+ * [8. Promote the release](#8-promote-the-release)
+ * [9. Publish Docker Images](#9-publish-docker-images)
+ * [A. No push access to apachepulsar org - use Personal account for staging the Docker images](#a-no-push-access-to-apachepulsar-org---use-personal-account-for-staging-the-docker-images)
+ * [Publish Docker Images to personal account in hub.docker.com (if you don't have access to apachepulsar org)](#publish-docker-images-to-personal-account-in-hubdockercom-if-you-dont-have-access-to-apachepulsar-org)
+ * [Copy Docker image from the Release manager's personal account to apachepulsar org](#copy-docker-image-from-the-release-managers-personal-account-to-apachepulsar-org)
+ * [B. Push access to apachepulsar org](#b-push-access-to-apachepulsar-org)
+ * [Publish Docker Images directly to apachepulsar org in hub.docker.com](#publish-docker-images-directly-to-apachepulsar-org-in-hubdockercom)
+ * [10. Release Helm Chart](#10-release-helm-chart)
+ * [11. Publish Python Clients](#11-publish-python-clients)
+ * [Linux](#linux)
+ * [MacOS](#macos)
+ * [12. Publish MacOS libpulsar package](#12-publish-macos-libpulsar-package)
+ * [13. Update Python Client docs](#13-update-python-client-docs)
+ * [14. Update swagger file](#14-update-swagger-file)
+ * [15. Write release notes](#15-write-release-notes)
+ * [16. Update the site](#16-update-the-site)
+ * [Update the site for major releases](#update-the-site-for-major-releases)
+ * [Update the site for minor releases](#update-the-site-for-minor-releases)
+ * [17. Announce the release](#17-announce-the-release)
+ * [18. Write a blog post for the release (optional)](#18-write-a-blog-post-for-the-release-optional)
+ * [19. Remove old releases](#19-remove-old-releases)
+ * [20. Move release branch to next version](#20-move-release-branch-to-next-version)
+
Review Comment:
We don't need this manually generated toc. On GitHub you can read toc as:
<img width="1728" alt="image" src="https://user-images.githubusercontent.com/18818196/188556629-6759b7aa-6acb-44c9-b9ca-05b9a9a2a56f.png">
A manual toc is hard to maintain.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Jason918 commented on a diff in pull request #17470: [doc] Fix the release process and regenerate the table of contents
Posted by GitBox <gi...@apache.org>.
Jason918 commented on code in PR #17470:
URL: https://github.com/apache/pulsar/pull/17470#discussion_r963191466
##########
wiki/release/release-process.md:
##########
@@ -412,35 +421,19 @@ $ twine upload pulsar_client-*.whl
### MacOS
-> **NOTES**
->
-> You need to install following softwares before proceeding:
->
-> - [VirtualBox](https://www.virtualbox.org/)
-> - [VirtualBox Extension Pack]
-> - [Vagrant](https://www.vagrantup.com/)
-> - [Vagrant-scp](https://github.com/invernizzi/vagrant-scp)
->
-> And make sure your laptop have enough disk spaces (> 30GB) since the build scripts
-> will download MacOS images, launch them in VirtualBox and build the python
-> scripts.
-
-Build the python scripts.
+There is a script that builds and packages the Python client inside Docker images.
```shell
-$ cd pulsar-client-cpp/python/pkg/osx/
-$ ./generate-all-wheel.sh v2.X.Y
+$ pulsar-client-cpp/python/build-mac-wheels.sh
```
The wheel files will be generated at each platform directory under `pulsar-client-cpp/python/pkg/osx/`.
Then you can run `twin upload` to upload those wheel files.
-If you don't have enough spaces, you can build the python wheel file platform by platform and remove the images under `~/.vagrant.d/boxes` between each run.
-
-## 13. Publish MacOS libpulsar package
+## 12. Publish MacOS libpulsar package
Review Comment:
1. I don't see how to install old version of `libpulsar` with `brew`
2. There is no record of non-latest version libpulsr PR in
[homebrew-core repo history](https://github.com/Homebrew/homebrew-core/pulls?q=is%3Apr+libpulsar+is%3Aclosed)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org