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.

Sign up for GitHub

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

Jump to bottom

CHANGELOG for v0.7 #838

Closed
7 tasks done
consideRatio opened this issue Aug 12, 2018 · 9 comments
Closed
7 tasks done

CHANGELOG for v0.7 #838

consideRatio opened this issue Aug 12, 2018 · 9 comments
Labels
documentation help wanted
Milestone
0.7

Comments

@consideRatio
Copy link
Member

consideRatio commented Aug 12, 2018 •
edited
Loading

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:

  • Bugs fixed
  • New features
  • Deprecated features
  • Breaking changes and required upgrade steps

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

PRs grouped by month since v0.6 sorted chronologically
@consideRatio consideRatio added this to the 0.7 milestone Aug 12, 2018
@choldgraf
Copy link
Member

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

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

manics commented Aug 15, 2018 •
edited by consideRatio
Loading

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

minrk commented Aug 16, 2018

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

betatim commented Aug 16, 2018

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:

  • I know the project likes to break things, so I look for what breaking changes happened in this release
  • I updated, something broke, now trying to find what caused this

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

Readthrough report

I think v0.7 can be summarized as

  • Support for JH 0.9
  • Fixing bugs (pre-pullers, culler, singleuser_ prefix)
  • Guide documentation improvements

Notes while reading through PRs

Bugfixes

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

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

@consideRatio
Copy link
Member Author

consideRatio commented Aug 19, 2018 •
edited
Loading

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
Copy link
Collaborator

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

@consideRatio consideRatio mentioned this issue Dec 12, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation help wanted
Projects
None yet
Milestone
0.7
Development

No branches or pull requests
6 participants
@yuvipanda @minrk @betatim @manics @choldgraf @consideRatio