Skip to content

Commit

Permalink
[added] Changelog generation from commit messages
Browse files Browse the repository at this point in the history
  • Loading branch information
mtscout6 committed Feb 16, 2015
1 parent 13baeaa commit 1ef51cb
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 2 deletions.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing

We welcome community support with both pull requests and reporting bugs. Please
don't hesitate to jump in.

## Tests

All commits that fix bugs or add features need a test.

## Commit Subjects for Public API Changes

If your patch **changes the API or fixes a bug** please use one of the following
prefixes in your commit subject:

- `[fixed] ...`
- `[changed] ...`
- `[added] ...`
- `[removed] ...`

That ensures the subject line of your commit makes it into the auto-generated
changelog. Do not use these tags if your change doesn't fix a bug and doesn't
change the public API.

### When using `[changed]` or `[removed]`...

Please include an upgrade path with example code in the commit message. If it
doesn't make sense to do this, then it doesn't make sense to use `[changed]` or
`[removed]` :). For further reading on writing a well formed commit message,
check out these [5 useful tips for a better commit
message](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message)

## Docs

Please update the docs with any API changes, the code and docs should always be
in sync.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@
"react-async": "~2.0.0",
"react-router-component": "git://github.com/STRML/react-router-component#react-0.12",
"requirejs": "~2.1.9",
"rf-changelog": "^0.4.0",
"semver": "~2.0.7",
"sinon": "^1.10.3"
}
}
}
10 changes: 9 additions & 1 deletion tools/release/tasks.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ module.exports = function(grunt) {
next();
},

// Generate Changelog
function(next) {
execSeries([
['node_modules/.bin/changelog', ['-t', 'v' + version]],
['git', ['add', path.join(repoRoot, 'CHANGELOG.md')]],
], next);
},

// Add and commit
function(next) {
execSeries([
Expand Down Expand Up @@ -109,7 +117,7 @@ module.exports = function(grunt) {

function(next) {
ReleaseRepo(docsRepo, docsRoot, tmpDocsRepo, version, next);
},
}

], complete);
});
Expand Down

0 comments on commit 1ef51cb

Please sign in to comment.