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

Publish GitHub release notes? #2933

Closed
jab opened this issue Nov 16, 2017 · 4 comments
Closed

Publish GitHub release notes? #2933

jab opened this issue Nov 16, 2017 · 4 comments
Labels
type: infrastructure improvement to development/releases/CI structure

Comments

@jab
Copy link
Contributor

jab commented Nov 16, 2017

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 nicoddemus added the type: infrastructure improvement to development/releases/CI structure label Nov 16, 2017
@nicoddemus
Copy link
Member

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. 👍

@nicoddemus nicoddemus changed the title Publish release notes? Publish GitHub release notes? Jul 6, 2018
@Zac-HD
Copy link
Member

Zac-HD commented Jun 22, 2019

@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
Copy link
Member

nicoddemus commented Jun 22, 2019

(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
Copy link
Member

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. 👍

nicoddemus added a commit to nicoddemus/pytest that referenced this issue Aug 10, 2019
nicoddemus added a commit to nicoddemus/pytest that referenced this issue Aug 11, 2019
nicoddemus added a commit to nicoddemus/pytest that referenced this issue Aug 11, 2019
nicoddemus added a commit to nicoddemus/pytest that referenced this issue Aug 11, 2019
nicoddemus added a commit to nicoddemus/pytest that referenced this issue Aug 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: infrastructure improvement to development/releases/CI structure
Projects
None yet
Development

No branches or pull requests

3 participants