2.0.4 • Published 7 years ago
logchange v2.0.4
logchange
Automatically generate a new version and changelog by parsing angular style git commit messages.
Installation
Global
$ npm install -g logchange
Local
$ npm install logchange
Add logchange as a script to your package.json
{
...
"scripts": {
...
"logchange": "logchange"
}
}
Commit messages mapping to versions
Breaking changes
feat(Scope): message
BREAKING CHANGE:
Some breaking change here.
This will increment the MAJOR version.
Features
feat(Scope): message
This will increment the MINOR version.
Fixes
fix(Scope): message
This will increment the PATCH version.
Usage
Usage: version [options]
Options:
-h, --help output usage information
-V, --version output the version number
-j, --json just output a version as json
-s, --stdout output to stdout instead of file
-f, --format <format> format to output in [markdown, html]
-o, --file <file> changelog file to read/write
Process
- Write your code
- Commit your code using angular style commits
- Test your code
- Run
logchange
(globally) / Runnpm run logchange
(locally) / Runyarn logchange
(locally/yarn) - Commit your
package.json
andCHANGELOG.md
with achore(Version): updating version and changelog
message. - message doesn't really matter - as long as its achore
otherwise, it may increment your version the next time you runlogchange
TODO
- fix issue with multiple version being bumped per execution.
- rewrite to support testing/coverage
- rework options to be a bit more intuitive
- add
logchange scopes
to iterate over the git log and return all the scopes already used - create contributors template, automatically increment number of commits against each contributor
- add
logchange current
to output the current version - add
logchange next
to output what the next version will be - format the scopes to all start with a capital letter, regardless of what case was used in the commit