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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFE: is it possible to start making github releases?馃 #10956

Closed
kloczek opened this issue Feb 27, 2024 · 4 comments 路 Fixed by #11057
Closed

RFE: is it possible to start making github releases?馃 #10956

kloczek opened this issue Feb 27, 2024 · 4 comments 路 Fixed by #11057
Labels
needs triage Needs a response from a contributor

Comments

@kloczek
Copy link

kloczek commented Feb 27, 2024

On create github release entry is created email notification to those whom have set in your repo the web UI Watch->Releases.
gh release can contain additional comments (li changelog) or additional assets like release tar balls (by default it contains only assets from git tag) however all those part are not obligatory.
In simplest variant gh release can be empty because subiekt of the sent email contains git tag name.

I'm asking because my automation process uses those email notifications by trying to make preliminary automated upgrades of building packages, which allows saving some time on maintaining packaging procedures.
Probably other people may be interested to be instantly informed about release new version as well.

Documentation and examples of generate gh releases:
https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository
https://cli.github.com/manual/gh_release_upload/
jbms/sphinx-immaterial#282
https://github.com/marketplace/actions/github-release
https://pgjones.dev/blog/trusted-plublishing-2023/
jbms/sphinx-immaterial#281 (comment)
tox target to publish on pypi and make gh release https://github.com/jaraco/skeleton/blob/928e9a86d61d3a660948bcba7689f90216cc8243/tox.ini#L42-L58

@github-actions github-actions bot added the needs triage Needs a response from a contributor label Feb 27, 2024
@hendrikmakait
Copy link
Member

cc @jrbourbeau, thoughts? Having automated release notifications would be nice, but I don't know the release process.

@mrocklin
Copy link
Member

Maybe @jacobtomlinson would have thoughts here. He's historically cared the most about automation.

@jacobtomlinson
Copy link
Member

I think this is more of a small change to the release procedure than an automation.

Given that the gh CLI tool is already mentioned in the release procedure it would be easy to add a one line command to create the "GitHub release" which is effectively just a pointer to a tag with optional text and file attachments.

At a minimum we could do the following after pushing the tags.

gh release create YYYY.M.X --notes-from-tag

We could also include the changelog as the release body, although this would include the whole changelog. We might want to be even more clever and just snip out the new section.

gh release create YYYY.M.X -F change.md

I assume we don't want to do things like attach the source distribution and wheel generated by build/twine to the release, but that would be easy to do as well. We just run another command after the build/twine step to upload the distributions.

gh release upload YYYY.M.X dist/*

Given that this generally done by @jrbourbeau I'll put it to him to set the appetite for doing this.

@kloczek
Copy link
Author

kloczek commented Apr 19, 2024

Thank you 馃憤 馃槃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs triage Needs a response from a contributor
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants