scikit-hep
Deprecate Tag Creator workflow in favor of nox + GitHub Releases auto-generated release notes?
Summary
While I'm a bit reluctant to suggest it (given how well the Tag Creator workflow has served us in the past), now that GitHub has introduced the new GitHub Releases) with auto-generated release notes (that also automatically pick up and tag new contributors) should we deprecate the Tag Creator workflow for using a workflow like pylhe and recast-atlas (where the actual publication to PyPI happens through an event that is kicked off through a release event when a GitHub release is published)?
If we used nox to run the "tag and push to master" system (@henryiii has already written up good examples of nox use and has examples for his projects) we still get pretty simple automation, but then if anything goes wrong we can try to figure it out and fix it before we go and make the GitHub release (which will then trigger the build and deploy to PyPI from the tag we just made). So it is a different system, with slightly more human-in-the-loop, but also easier to debug.
The auto-generated release notes were used for recast-atlas v0.1.8 and worked really nicely to use IMO.
This would also avoid situations where concurrency could be problematic (c.f. PR #1632)
Thoughts @kratsg and @lukasheinrich?
Additional Information
- October 4, 2021 GitHub Blog post A new public beta of GitHub Releases: How we’re improving the release experience
- GitHub YouTube video: AUTOMATED Release Notes - GitHub Checkout (no CC :disappointed:)
Code of Conduct
- [X] I agree to follow the Code of Conduct
An alternative to nox is just to have things run in a bump version GHA workflow like this one. Using workflow_dispatch you put in the part (major/minor/patch) manually and then have the workflow run the rest.
The idea behind nox is that it doesn't tie you to custom CI-specific code. You can still run nox in the GHA workflow, but you can develop it locally, and if we have to migrate to some other platform someday, you can take nox with you.
You can still run nox in the GHA workflow, but you can develop it locally, and if we have to migrate to some other platform someday, you can take nox with you.
Yeah. I didn't say this explicitly, but I should have said "an alternative to running nox locally".