chore(changelog): add git-changelog config and sample CHANGELOG.md

This is the setup for the Grunt task that generates a changelog. Note
that it currently generates the changelog for the range
changelog-start..HEAD where changelog-start is a tag. It will always use
the most recent tag it can find. We may want to change this
behavior. Also, the original repo has some bugs, so I'm using my fork
until he accepts my PRs.

Migration notes: To run: `grunt git_changelog`
This commit is contained in:
Cole Gleason
2014-01-16 02:10:00 -06:00
parent 1b170158ce
commit 564241cd38
4 changed files with 39 additions and 1 deletions

7
CHANGELOG.md Normal file
View File

@@ -0,0 +1,7 @@
<a name="">HabitRPG</a>
# (2014-01-16)
## Breaking Changes

11
EXTENDEDCHANGELOG.md Normal file
View File

@@ -0,0 +1,11 @@
<a name="">HabitRPG</a>
# (2014-01-16)
## Chore
- **changelog:** add commit-msg hook to verify commit messages
## Breaking Changes

View File

@@ -4,6 +4,24 @@ module.exports = function(grunt) {
// Project configuration.
grunt.initConfig({
git_changelog: {
minimal: {
options: {
repo_url: 'https://github.com/habitrpg/habitrpg',
appName : 'HabitRPG',
branch_name: 'develop'
}
},
extended: {
options: {
file: 'EXTENDEDCHANGELOG.md',
repo_url: 'https://github.com/habitrpg/habitrpg',
appName : 'HabitRPG',
branch_name: 'develop',
grep_commits: '^fix|^feat|^docs|^refactor|^chore|BREAKING'
}
}
},
karma: {
unit: {
@@ -124,5 +142,6 @@ module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-hashres');
grunt.loadNpmTasks('grunt-karma');
grunt.loadNpmTasks('git-changelog');
};

View File

@@ -80,6 +80,7 @@
"mongoskin": "~0.6.1",
"expect.js": "~0.2.0",
"superagent": "~0.15.7",
"superagent-defaults": "~0.1.5"
"superagent-defaults": "~0.1.5",
"git-changelog": "colegleason/git-changelog"
}
}