Skip to content
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

Merged

Conversation

Nusnus
Copy link
Member

@Nusnus Nusnus commented Sep 5, 2023

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.

@Nusnus Nusnus requested review from thedrow, auvipy and a team September 5, 2023 20:14
@Nusnus Nusnus self-assigned this Sep 5, 2023
@Nusnus Nusnus marked this pull request as ready for review September 5, 2023 20:15
@Nusnus Nusnus marked this pull request as draft September 5, 2023 20:17
@Nusnus Nusnus force-pushed the patch_version_release_checklist branch from 0d86cf6 to 6155d0d Compare September 6, 2023 13:15
- 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.
Copy link
Member

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

Copy link
Member Author

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.
Copy link
Member

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

Copy link
Member

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.

Copy link
Member

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

Copy link
Member Author

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.
Copy link
Member

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

Copy link
Member Author

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@Nusnus Nusnus force-pushed the patch_version_release_checklist branch from a9552fd to 4a822d3 Compare September 14, 2023 13:33
@Nusnus Nusnus marked this pull request as ready for review September 14, 2023 13:35
@Nusnus
Copy link
Member Author

Nusnus commented Sep 14, 2023

@auvipy I’ve pushed some changes, please review again.

@auvipy auvipy self-requested a review September 14, 2023 14:10
Nusnus and others added 3 commits September 14, 2023 18:05
…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>
@Nusnus Nusnus force-pushed the patch_version_release_checklist branch from 4a822d3 to d03dbbd Compare September 14, 2023 15:05
@auvipy auvipy merged commit ba994d8 into celery:main Sep 17, 2023
6 checks passed
@Nusnus Nusnus deleted the patch_version_release_checklist branch September 17, 2023 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants