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

Automating release #331

Open
jakirkham opened this issue Aug 2, 2023 · 4 comments
Open

Automating release #331

jakirkham opened this issue Aug 2, 2023 · 4 comments

Comments

@jakirkham
Copy link
Member

To simplify the release process, wonder if it would be worthwhile to bake most of the release steps into a GHA workflow that responds to a git tag

It could for example generate release notes that are included in a GitHub release. Also it could create the whl & sdist artifacts and upload them to PyPI

The conda-forge bot already submits new releases. Though we could start them more quickly using the @conda-forge-admin, please update version bot request in a dask-image feedstock issue

@jakirkham
Copy link
Member Author

It's worth noting that sdist & whls are handled here

So this come down to automating the release notes more than anything

run: |
python setup.py sdist bdist_wheel
twine upload dist/*

@GenevieveBuckley
Copy link
Collaborator

I'd be 100% on board with anything that makes it easier and simpler in the long run.

And I would not be surprised if the release notes are doing things in a more complicated way than necessary... because I was the one who wrote most of those and I might be doing things in a more complicated way than necessary! Improvements are very welcome 😄

@m-albert
Copy link
Collaborator

m-albert commented Aug 4, 2023

So this come down to automating the release notes more than anything

And I would not be surprised if the release notes are doing things in a more complicated way than necessary... because I was the one who wrote most of those and I might be doing things in a more complicated way than necessary! Improvements are very welcome 😄

I guess one step that takes a bit of time is to generate the release notes and create a PR for adding them to HISTORY.rst. I've just seen that github can also automatically generate release notes.

@GenevieveBuckley
Copy link
Collaborator

I guess one step that takes a bit of time is to generate the release notes and create a PR for adding them to HISTORY.rst. I've just seen that github can also automatically generate release notes.

Sure, let's do that.

Context for current situation: the release note generation script was based off the one used by scikit-image, which was created before github had this feature. So we don't need to keep doing things that way anymore.

To switch, it sounds like we need to:

  1. Update the release guide notes
  2. Switch the HISTORY.rst file (and/or all the dask-image RST docs?) to use markdown instead of RST. That way we can easily copy-paste the release notes into it.

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

No branches or pull requests

3 participants