Merge pull request #954 from deis/changelog-script

feat(contrib): add changelog generation script

Author: Matthew Fisher

CHANGELOG.md

@@ -1,5 +1,3 @@
-## Change Log
-
 ### v0.8.0 (2014/05/06 18:30 +00:00)
 - [54ff9ca](https://github.com/deis/deis/commit/54ff9caaaaa2be20960afe41c883014a796b81b2) Updated CLI binaries and links in client README. (@mboersma)
 - [4694844](https://github.com/deis/deis/commit/4694844e603583d2b0cee0fa0b4922a9857dc5d9) Switch master to v0.8.0. (@mboersma)
@@ -1460,4 +1458,4 @@
 - [4ebd123](https://github.com/deis/deis/commit/4ebd123a1c37c539ea3e8a1909d4e5b422d8441c) standardize list and info cli output (@gabrtv)
 - [abbc10a](https://github.com/deis/deis/commit/abbc10a2a0b6006353cc467cb87813293713c7df) fix flake8 line length (@gabrtv)
 - [8834b94](https://github.com/deis/deis/commit/8834b946a99a40828a5e6ef01d06adab67e17e22) check for valid flavor on formations:create, add time-based done output #16 (@gabrtv)
-- [72b8345](https://github.com/deis/deis/commit/72b8345ac6557a2c4707208a13a2c407478f740b) update in prep for 0.0.4 release (@gabrtv)
+- [72b8345](https://github.com/deis/deis/commit/72b8345ac6557a2c4707208a13a2c407478f740b) update in prep for 0.0.4 release (@gabrtv)

contrib/util/generate-changelog.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+
+usage() {
+    echo "Usage: $0 <from> [to]"
+}
+
+retrieve() {
+    git --no-pager log --oneline --no-merges --grep="$1" $FROM..$TO
+}
+
+subheading() {
+    echo "#### $1\n"
+    retrieve "$2"
+    echo
+}
+
+FROM=$1
+TO=${2:-"HEAD"}
+
+if [ -z $1 ];
+then
+    usage
+    exit 1
+fi
+
+echo "### $FROM -> $TO\n"
+
+subheading "Features" "feat("
+subheading "Fixes" "fix("
+subheading "Documentation" "docs("

docs/contributing/releases.rst

@@ -23,8 +23,8 @@ github.com/deis/deis Repo
 - Move any `deis open issues`_ from the current release to the
   next milestone
 - Close the current `deis milestone`_
-- Recreate CHANGELOG.md in the root of the project using `github-changes`_
-    * ``github-changes -o opdemand -r deis -n vX.Y.Z``
+- Recreate CHANGELOG.md in the root of the project using the `changelog script`_
+    * ``./contrib/util/generate-changelog.sh v0.7.0 v0.8.0 | cat - CHANGELOG.md > tmp && mv tmp CHANGELOG.md``
     * proofread the new CHANGELOG.md to ensure it was generated correctly
     * ``git add CHANGELOG.md && git commit -m "Updated CHANGELOG.md."``
 - Merge git master into release branch locally
@@ -83,7 +83,7 @@ Documentation
 
 .. _`deis milestone`: https://github.com/deis/deis/issues/milestones
 .. _`deis open issues`: https://github.com/deis/deis/issues?state=open
-.. _`github-changes`: https://lalitkapoor.github.io/github-changes/
+.. _`changelog script`: https://github.com/deis/deis/blob/master/contrib/util/generate-changelog.sh
 .. _`release notes`: https://github.com/deis/deis/releases
 .. _`aws-eng S3 bucket`: https://s3-us-west-2.amazonaws.com/opdemand/
 .. _`Deis Pypi`:  https://pypi.python.org/pypi/deis/