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

Additions to release guide and change to release note generation script #339

Merged

Conversation

m-albert
Copy link
Collaborator

@m-albert m-albert commented Aug 4, 2023

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.py to HISTORY.rst and 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

  1. adding minor changes to the release guide and
  2. modifying the relevant part of generate_release_notes.py to 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.

script which could output invalid restructuredtext
@m-albert m-albert mentioned this pull request Aug 4, 2023
@@ -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
Copy link
Collaborator

Choose a reason for hiding this comment

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

Ooh, I learned something new! Thanks!

@GenevieveBuckley
Copy link
Collaborator

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 GenevieveBuckley merged commit 86b56a7 into dask:main Aug 8, 2023
11 checks passed
@m-albert
Copy link
Collaborator Author

m-albert commented Aug 9, 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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants