simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated commit analysis (markdown)

Stephan Bönnemann 2015-04-24 00:52:34 +02:00
parent f316eee65b
commit 4ba74c7ec8
1 changed files with 52 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
commit-analysis.md

@ -1 +1,52 @@
soon.jpg ## default analyzer
The default analyzer implements the [AngularJS Commit Message Convention](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) style.
```
<type>(<scope>): <subject>
<BLANK LINE>
<body>
```
Examples:
```
feat(ruler): add inches as well as centimeters
```
```
fix(protractor): fix 90 degrees counting as 91 degrees
```
```
fix(pen): use blue ink instead of red ink
BREAKING CHANGE: Pen now uses blue ink instead of red.
To migrate, change your code from the following:
`pen.draw('blue')`
To:
`pen.draw('red')`
```
[Synopsis](https://github.com/ajoslin/conventional-changelog/blob/master/CONVENTIONS.md)
## custom analyzers
If you want to use commit message conventions other than Angular's you can provide your own analyzer in the `package.json`.
Add a `release` field and provide a path where `semantic-release` can require your analyzer:
```json
"release": {
"analyzer": "./lib/custom-analyzer"
}
```
The module should export a function that takes an array of commit objects (`{hash: '123456', message: 'changed stuff'`) and returns the the release type (`'major'`, `'premajor'`, `'minor'`, `'preminor'`, `'patch'`, `'prepatch'`, or `'prerelease'`), or `null` to not release a new version.
Have a look at [the default analyzer](https://github.com/boennemann/semantic-release/blob/plugin-wip/lib/analyzer.js) for a sample implementation.