DOC: update documentation on how to prepare and do a release #29732
Conversation
`pavement.py` was recently removed, and the replacement no longer needs a manual change. The git version no longer depends on `.dev0` tags, so remove that note. However, keep adding those tags, because why not - it's useful to navigate to the start of the development for a release series.
| $ git commit --allow-empty -m'REL: Begin NumPy 1.22.0 development' | ||
| $ git commit --allow-empty -m'REL: Begin NumPy 2.4.0 development' | ||
| $ git push upstream HEAD | ||
|
|
There was a problem hiding this comment.
I've changed this in practice, but not yet here. I just make it an ordinary PR, when it goes in marks the beginning of new development. I did that because pushing directly to the branch bothers me, and a PR is more flexible. I can make those modifications after this goes in.
I also use that PR to set the development version in pyproject.toml, which is all that is needed since I removed pavement.py and put write_release in tools.
There was a problem hiding this comment.
Want me to change it here?
There was a problem hiding this comment.
No, I need to think a bit to recall exactly what I did last time. I also included the other stuff needed, it was #29019.
There was a problem hiding this comment.
It was a bit of an experiment, but I think it was an improvement.
| This needs to be done after all installers are downloaded, but before the pavement | ||
| file is updated for continued development:: | ||
|
|
||
| $ python write_release 2.1.0 |
There was a problem hiding this comment.
I'll add this back as python tools/write_release 2.4.0 as it translates the release notes into Markdown.
| filenames and sizes look as expected. If desired, you can also download an | ||
| artifact for local unzipping and inspection. You will get an email notification | ||
| as well with a "Review pending deployments" link. Once you're ready, press the | ||
| button to start the uploads to PyPI, which will complete the release. |
There was a problem hiding this comment.
I can't recreate the popup with the exact text right now without running a new deployment, but it's something like "Approve deployment". There's only one button that shows up once you follow "Review pending deployments".
How about I tweak the text to say "Once you're done reviewing, press the "Approve deployment" button to start ..." and then if it's not 100% accurate, you can make it more accurate when you use these instructions for 2.4.0?
There was a problem hiding this comment.
Sounds good. This is a living document :)
|
Looks generally good. I'll update the walkthroughs a bit more if needed after this goes in. |
|
Thanks Ralf. I'll work on the two walkthroughs. |
|
Sounds good, thanks Chuck |
2 participants
numpy-releaserepoCloses gh-29462