Additions to release guide and change to release note generation script #339
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
script which could output invalid restructuredtext
Closed
| @@ -171,10 +174,17 @@ conda-forge feedstock here: https://github.com/conda-forge/dask-image-feedstock | |||
| Note: the conda-forge bot will not open a PR for any of the release candidates, | |||
| only for the final release. Only one PR is opened for | |||
|
|
|||
| As an alternative to waiting for the conda-forge bot to notice the new release, | |||
| you can submit a new dask-image feedstock issue indicating | |||
| ``@conda-forge-admin, please update version`` in the issue title. This will | |||
There was a problem hiding this comment.
Ooh, I learned something new! Thanks!
|
Thank you for the update while it's all still fresh in your mind. And yes, absolutely this can be transitory and be replaced by your suggestion very soon. But it's still valuable to have this, and I appreciate you doing it. |
GenevieveBuckley
approved these changes
Aug 8, 2023
|
Thank you for reviewing this Genevieve! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While creating the 2023.08.0 release (#330) I could test the fantastic release guide by @GenevieveBuckley and found it super useful. Basically everything worked as described (there was some trouble during the release but unrelated to the release notes).
I didn't find that any particular step could be much simpler, but I completely agree that there's potential for automatization as discussed in #331.
One little problem that I encountered was that after copying the release notes generated by
generate_release_notes.pytoHISTORY.rstand creating a release (candidate), twine complained about invalid restructured text. It turned out to be a too short title underline #334.So in this PR I'm
generate_release_notes.pyto produce rst compatible title underlines.Of course, this might not be very important or at least very transitory in the light of migrating to a more automated release process.