Create a single place to track releases across the JupyterHub sub-projects #798
Description
Actions
- Decide if this is something we'd like to do
- Choose the place where this information will go (maybe
hub.jupyter.org?) - Decide if we should do more ambitious "aggregate changelogs", or just link to changelogs and have a list of releases.
- Implement it and see if it looks useful
Context
It can be challenging to track the updates coming out of the JupyterHub project. This is in-part because we don't have a single place somebody can reference to learn what the project has been up to. We also don't have a standardized way across projects for recording releases and changelogs, which adds burden to users to quickly learn about the new changes in projects.
We also often write really nice release notes, and if we can make them more discoverable, it would make them more useful!
We had a back and forth in Zulip and kicked around a few ideas.
We decided that an easy first step would be creating a centralized list of releases across JupyterHub projects. This would be low-effort and a step in the right direction.
Suggestion
We can't easily aggregate all the release notes from individual releases, because we don't store release notes in an easily-referenceable place like a GitHub release - they tend to be appended to a big "CHANGELOG" file. So @manics suggested we write a lightweight script to do something like:
- Assume every tag in a jupyterhub repository corresponds to a release.
- Assume each tag has a standardized header naming pattern in a changelog.
- Parse all repositories for tags.
- For every tag, find its corresponding section in the hard-coded changelogs.
- Aggregate them all in one place.
Here's a script that roughly does this
e.g. python extract-tag-changelog.py jupyterhub/jupyter-server-proxy v4.0.0