conventional-changelog-cli
Advanced tools
conventional-changelog-cli - npm Package Compare versions
Comparing version 1.1.0 to 1.1.1
@@ -0,1 +1,7 @@ | ||
| <a name="1.1.1"></a> | ||
| ## [1.1.1](https://github.com/stevemao/conventional-changelog-cli/compare/v1.1.0...v1.1.1) (2016-02-14) | ||
| <a name="1.1.0"></a> | ||
@@ -2,0 +8,0 @@ # [1.1.0](https://github.com/stevemao/conventional-changelog-cli/compare/v1.0.0...v1.1.0) (2016-02-13) |
@@ -46,2 +46,3 @@ #!/usr/bin/env node | ||
| ' -n, --config A filepath of your config script', | ||
| ' Example: https://github.com/stevemao/conventional-changelog-angular/blob/master/index.js', | ||
| ' This value is ignored if preset is specified', | ||
@@ -48,0 +49,0 @@ '', |
| { | ||
| "name": "conventional-changelog-cli", | ||
| "version": "1.1.0", | ||
| "version": "1.1.1", | ||
| "description": "Generate a changelog from git metadata", | ||
@@ -5,0 +5,0 @@ "homepage": "https://github.com/stevemao/conventional-changelog-cli", |
@@ -7,2 +7,3 @@ # conventional-changelog-cli | ||
| **Note** You don't have to use the angular commit convention. For the best result of the tool to tokenize you commit and produce flexible output, it's recommended to use a commit convention. | ||
@@ -34,2 +35,9 @@ ## Quick start | ||
| ## Example output | ||
| - https://github.com/ajoslin/conventional-changelog/blob/master/CHANGELOG.md | ||
| - https://github.com/karma-runner/karma/blob/master/CHANGELOG.md | ||
| - https://github.com/btford/grunt-conventional-changelog/blob/master/CHANGELOG.md | ||
| ## Recommended workflow | ||
@@ -54,18 +62,24 @@ | ||
| ## Example output | ||
| - https://github.com/ajoslin/conventional-changelog/blob/master/CHANGELOG.md | ||
| - https://github.com/karma-runner/karma/blob/master/CHANGELOG.md | ||
| - https://github.com/btford/grunt-conventional-changelog/blob/master/CHANGELOG.md | ||
| ## Why | ||
| - Used by AngularJS and related projects. | ||
| - Used by AngularJS, JSHint and related projects. | ||
| - Easy fully automate changelog generation. You could still add more points on top of it. | ||
| - Ignoring reverted commits, templating with [handlebars.js](https://github.com/wycats/handlebars.js) and links to references, etc. Open an [issue](../../issues/new) if you want more reasonable features. | ||
| - Intelligently setup defaults but yet fully configurable with presets of popular projects. | ||
| - Intelligently setup defaults but yet fully configurable with presets of [popular projects](https://github.com/ajoslin/conventional-changelog#preset). | ||
| - Everything internally or externally is pluggable. | ||
| - A lot of tests and actively maintained. | ||
| ### Problems with [github-changelog-generator](https://github.com/skywinder/github-changelog-generator) or similar projects | ||
| - Opinionated on how to write commits, issues or PRs. | ||
| - No or partially support reference links. | ||
| - Not system agnostic. Only support GitHub. | ||
| - No template support. The output is mostly certain format of markdown. | ||
| - No presets of popular commit message conventions. | ||
| - Not modularized. Over the years [modularization is proven to be the best practice](https://github.com/sindresorhus/ama/issues/10#issuecomment-117766328). | ||
| - No tests or coverage is too low. Program might be buggy. | ||
| - Do not read your project's environment. | ||
| - No or few task runner or build tool integrations. | ||
| ## Related | ||
@@ -72,0 +86,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by9.87%
14491
- Lines of code
- increased by0.59%
170
- Number of lines in readme file
- increased by15.38%
105