search

jupyterhub / zero-to-jupyterhub-k8s

Helm Chart & Documentation for deploying JupyterHub on Kubernetes
https://zero-to-jupyterhub.readthedocs.io
Other
1.52k stars 792 forks source link

CHANGELOG for v0.7 #838

Closed consideRatio closed 6 years ago

consideRatio commented 6 years ago

Preparation for v0.7

Our CHANGELOG hygiene is bad, time to take a bath, all help summarizing the changes is greatly appreciated. Our goal is to summarize the PRs, and the following aspects are relevant to consider in order to make a new CHANGELOG entry:

There are 520 commits since the latest release at the moment.

PRs grouped by month since v0.6 sorted chronologically

choldgraf commented 6 years ago

@consideRatio as a separate point, I think it'd be great if we adopted some team guidelines for adding to a CHANGELOG as we add new features

consideRatio commented 6 years ago

Yes it would be great! I'd like to add a checkbox for it in the PR templates like yuvi did for TLJH. It would worked on me as a helpful nudge and reminder both for my own PRs as well as the ones I've merged.

manics commented 6 years ago

If it helps I've got a script for listing pull requests... I've modified it to give the full check-list for the search query is:pr is:merged merged:2018-02-01..2018-08-15 base:master sort:updated-asc repo:jupyterhub/zero-to-jupyterhub-k8s

minrk commented 6 years ago

as a separate point, I think it'd be great if we adopted some team guidelines for adding to a CHANGELOG as we add new features

This one is tricky. Updating the changelog in each PR effectively guarantees that all PRs will conflict with each other. Some projects solve this by asking PRs to create a new file with a fragment, e.g. called pr-my-new-feature.md and then script periodic merging of pr-*.md into CHANGELOG.md.

betatim commented 6 years ago

Do we actually need a detailed and exhaustive changelog?

As a user there are only a few cases when I actually look at a Changelog:

In both cases I don't actually want a list of every one of the 500 PRs that got merged, only the ones that might be to blame for the breakage. Beyond that one or two lines of headline/show case new features/bug fixes is nice.

So maybe we can find a compromise where the ChangeLog is hand curated as we go along for PRs that (potentially) cause breakage. Less work for us, and for me (as a user) more useful to have a heavily curated changelog.

consideRatio commented 6 years ago

Readthrough report

I think v0.7 can be summarized as

Notes while reading through PRs

@minrk while I didn't inspect the PRs thoroughly, I did not see anything that would require canges to config.yaml files. Did you recall some changes we must help user do?

consideRatio commented 6 years ago

@manics thanks for the script output it was of great use for me to overview the changes better!

consideRatio commented 6 years ago

I'm currently writing the changelog and upgrade instructions etc...

Choosing a cricket player for the release that deserves a reference may be a challenge for me though! @yuvipanda ?

yuvipanda commented 6 years ago

I've picked a cricketer - http://www.espncricinfo.com/story/_/id/24453149/alex-blackwell-speaks-role-agent-change-cricket. Alex Blackwell is the first openly queer woman cricketer at the international stage. https://en.wikipedia.org/wiki/Alex_Blackwell