From c0ec7ccd9d4044cc8970c1ec126791671d12ac79 Mon Sep 17 00:00:00 2001 From: David Date: Fri, 26 Feb 2016 11:09:17 +0100 Subject: [PATCH] release notes awk script --- Release-Process.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/Release-Process.md b/Release-Process.md index d1399f9..2a5bdc0 100644 --- a/Release-Process.md +++ b/Release-Process.md @@ -30,7 +30,20 @@ First, get the latest tools. ## Update the CHANGELOG and test -See https://github.com/weaveworks/scope/compare/latest_release...master for a diff. +See https://github.com/weaveworks/scope/compare/latest_release...master for a diff. +A starting point for the CHANGELOG entry for this release can be obtained by running a little CLI-fu. (Make sure to have `jq` installed for JSON processing.): + +``` +# update latest_release tag in local clone +git fetch -t origin +# get merged PR titles +git log --oneline latest_release...master | grep "Merge pull request" | awk '{issue=substr($5, 2)} \ + {system("curl -s https://api.github.com/repos/weaveworks/scope/issues/" issue "| jq \".title\"")} \ + {print "\t["$5"](https://github.com/weaveworks/scope/pull/" issue ")"}' | sed -e 's/^"/- /' | sed -e 's/"$//' +``` + +Then sort the lines by feature, bug fix, performance etc. sections. +You may find it helpful to look at the original issues of the PRs to see what they are about. Commit and push the CHANGELOG to the release branch. Also, load the release branch on your test machines, and click around. Only proceed from here once you have a few LGTMs.