-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[doc] Fix the release process #17470
[doc] Fix the release process #17470
Conversation
### 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 apache#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.
@Jason918 I've updated the documents. PTAL again. |
@BewareMyPower This is a great improvement. I think we can send a discuss to mail-list to draw more attentions. |
@Jason918 Good suggestion. I have sent an email just now. |
I will continue the release process of 2.8.4 from tomorrow and update this PR as well. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This process looks much cleaner now. Great work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your updates @BewareMyPower! Comments inline.
|
||
git commit -m 'Bumped version to 2.X.Y-SNAPSHOT' -a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
git commit -m 'Bumped version to 2.X.Y-SNAPSHOT' -a | |
git add . | |
git commit -s -m 'Bumped version to 2.X.Y-SNAPSHOT' |
In case of the files aren't tracked yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should add them to .gitignore
instead, lol. But fair enough to keep as is.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, we should.
@michaeljmarshall @Jason918 I have also adopted your suggestions in the email, see the new Preparation section. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for refreshing the process document! I left a few minor suggestions.
Thanks for your comments @momo-jun, they're addressed now. |
### 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 apache#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.
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
the release process.
notes" sections because they should be done in the last few steps and
they have already been documented.
the following step by just copying approved candidate images from the
personal account to the official apachepulsar account.
need the VirtualBox after [Python] Added script to generate Wheel files for MacOS #15024.
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)
doc
(Your PR contains doc changes)
doc-complete
(Docs have been already added)