-
-
Notifications
You must be signed in to change notification settings - Fork 4.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
Patch Version Release Checklist #8488
Patch Version Release Checklist #8488
Conversation
0d86cf6
to
6155d0d
Compare
- Generate Markdown release notes | ||
<img width="389" alt="CleanShot 2023-09-05 at 22 13 39@2x" src="https://github.com/celery/celery/assets/4662342/83c6a4b6-1676-496e-8d75-5a6b10352b5b"> | ||
|
||
- Copy the generated release notes. |
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 this counter intuitive to me
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 know it's a "dummy level" checklist but the point is avoiding human-error.
Do you want me to change this then? @auvipy
:release-date: YYYY-MM-DD HH:MM P.M/A.M TimeZone | ||
:release-by: Release Manager Name | ||
|
||
Changes list in RST format. |
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.
we can consider changing the changelog from rst to md in near future. this will reduce some repeating/converting stuff
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.
We cannot change the changelog format to markdown since we include the changelog in our documentation site which uses RST.
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.
wasn't fully aware of that. have to cross check. thanks for sharing the insight
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.
We cannot change the changelog format to markdown since we include the changelog in our documentation site which uses RST.
Few lines below here:
These changes will reflect in the [Change history](https://docs.celeryq.dev/en/stable/changelog.html
I think that's what @thedrow was referring to @auvipy - I added it specifically for that Markdown/RST formatting question/topic.
twine upload dist/celery-X.Y.Z* | ||
``` | ||
|
||
> ⚠️ **Warning:** The release manager should double check that the release details are correct (project/version) before publishing the release to PyPI. |
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.
Another thing we could consider adding here or any other docs that we should only yank recently released version
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.
Good point, I'll add it.
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.
Done
a9552fd
to
4a822d3
Compare
@auvipy I’ve pushed some changes, please review again. |
…Checklist.md The issue will guide maintainers on how to execute patch releases. It will contain both instructions and a live checklist for the community to follow on progress and updates.
by @thedrow Co-authored-by: Omer Katz <omer.katz@kcg.tech>
4a822d3
to
d03dbbd
Compare
Due to the recent issues with v5.3.2 and v5.3.3, I suggest a new how-to for releasing a new patch version.
The purpose is to avoid such critical errors in the future and standardize Celery's release procedure.
We'll start with improving the patch release procedure to allow more frequent patch releases of Celery and if it works, we can apply the same improvements and insights to minor and major version releases.