HGVSnomenclature / hgvs-nomenclature

HGVS Nomenclature website
https://hgvs-nomenclature.org/
MIT License
5 stars 6 forks source link

Automate release notes #176

Closed reece closed 3 months ago

reece commented 3 months ago

This PR streamlines the release flow by pulling the release notes from GitHub directly into the generated docs at build time. These notes obviate the release notes that were maintained manually in docs/versions/21.0.md. The release process docs (dev-docs/release-new-version.md) were updated appropriately.

Advantages

Disadvantages

Most of these disadvantages can be overcome by creating and committing version page as before, and then making the page for only the most recent major.minor.

Comparing https://hgvs-nomenclature.org/stable/versions/21.0/ and https://hgvs-nomenclature--176.org.readthedocs.build/176/versions/21.0/ shows that these pages are nearly identical with the exception of the admonition.

reece commented 3 months ago

Nice changes, @ifokkema .

I removed your inline 21.0.0 release notes and created a new 21.0.0. release in github. The output is essentially identical, but it means that users will also now see a 21.0.0 release in github and that the release notes work the same as the others. Thanks for catching that omission!

Since this is essentially a refinement on code that you already reviewed, I'm going to merge as-is.

ifokkema commented 3 months ago

I removed your inline 21.0.0 release notes and created a new 21.0.0. release in github.

Makes sense! I didn't realize it would nicely sort the way it does; I thought a new release would just get in the way. This is much better, indeed! Thanks!