Publish GitHub release notes?

[jab]

Any interest in publishing release notes to https://github.com/pytest-dev/pytest/releases?

This would help users follow progress more proactively, especially if using tools such as Sibbell. Currently pages like https://sibbell.com/github/pytest-dev/pytest/3.2.5/ are blank because of the lack of release notes.

[nicoddemus]

Hi @jab, thanks for the suggestion.

I wouldn't mind at all using GitHub Releases, only that right now we have an automated system using towncrier to generate our CHANGELOGs. If someone wants to automate the process so that GH Releases are updated automatically, I'm all for it. 👍

[Zac-HD]

@nicoddemus (cc @blueyed @asottile) - I've been putting something together for Hypothesis to run Sphinx with the plain text builder, grab the latest changelog from the built file, and upload that to GitHub releases and Tidelift.

Feel free to copy it! I had a quick look at sphinx-markdown-builder but haven't adopted it yet, though that's a pretty obvious enhancement. Using a builder rather than just clipping the rst formatting is pretty important though, as the more detailed markup tends to look pretty weird in markdown.

If you have something that can run after release in CI (or even just as a manual script) though, updating both GH releases and Tidelift is basically painless.

[nicoddemus]

(Nice to know Hypothesis is also on Tidelift! 😁)

Thanks for sharing this. I've had a brief conversation with @jaraco in jaraco/jaraco.tidelift#1, which has started jaraco.tidelift for this purpose.

I believe the hardest part of a general "upload release notes" process is getting the release notes, as projects use wildly different approaches to that.

Anyway the work you already done is definitely great already, and can be used as basis for a more general project, or something that works with towncrier. 👍

This thread also gives me the idea of writing a generic "changelog uploader to Tidelift and GH release notes", based on towncrier (at least initially).

Ahh so many interesting projects to tackle, so little time. 😁

[nicoddemus]

Just to note, Tidelift now automatically scans for GitHub release notes, so just uploading the release notes to GH will also solve this for Tidelift. 👍