Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
conventional-changelog-cli
Advanced tools
conventional-changelog-cli - npm Package Compare versions
Comparing version 1.3.3 to 1.3.4
@@ -6,2 +6,5 @@ # Change Log | ||
| <a name="1.3.4"></a> | ||
| ## [1.3.4](https://github.com/conventional-changelog/conventional-changelog-cli/compare/conventional-changelog-cli@1.3.3...conventional-changelog-cli@1.3.4) (2017-10-01) | ||
| <a name="1.3.3"></a> | ||
@@ -8,0 +11,0 @@ ## [1.3.3](https://github.com/conventional-changelog/conventional-changelog-cli/compare/conventional-changelog-cli@1.3.2...conventional-changelog-cli@1.3.3) (2017-09-01) |
| { | ||
| "name": "conventional-changelog-cli", | ||
| "version": "1.3.3", | ||
| "version": "1.3.4", | ||
| "description": "Generate a changelog from git metadata", | ||
@@ -36,3 +36,3 @@ "homepage": "https://github.com/conventional-changelog/conventional-changelog-cli", | ||
| "add-stream": "^1.0.0", | ||
| "conventional-changelog": "^1.1.5", | ||
| "conventional-changelog": "^1.1.6", | ||
| "lodash": "^4.1.0", | ||
@@ -39,0 +39,0 @@ "meow": "^3.7.0", |
@@ -34,3 +34,3 @@ # conventional-changelog-cli | ||
| To fully customize the tool, please checkout [conventional-changelog](https://github.com/ajoslin/conventional-changelog) and [conventional-changelog-core](https://github.com/conventional-changelog/conventional-changelog-core) docs. You can find more details there. **Note: `config` here can work with `preset`, which is different than `options.config` in conventional-changelog.** | ||
| To fully customize the tool, please checkout [conventional-changelog](https://github.com/ajoslin/conventional-changelog) and [conventional-changelog-core](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core) docs. You can find more details there. **Note: `config` here can work with `preset`, which is different than `options.config` in conventional-changelog.** | ||
@@ -48,18 +48,44 @@ | ||
| 1. Make changes | ||
| 2. Commit those changes | ||
| 3. Make sure Travis turns green | ||
| 4. Bump version in `package.json` | ||
| 5. `conventionalChangelog` | ||
| 6. Commit `package.json` and `CHANGELOG.md` files | ||
| 7. Tag | ||
| 8. Push | ||
| 1. Commit those changes | ||
| 1. Make sure Travis turns green | ||
| 1. Bump version in `package.json` | ||
| 1. `conventionalChangelog` | ||
| 1. Commit `package.json` and `CHANGELOG.md` files | ||
| 1. Tag | ||
| 1. Push | ||
| The reason why you should commit and tag after `conventionalChangelog` is that the CHANGELOG should be included in the new release, hence `gitRawCommitsOpts.from` defaults to the latest semver tag. | ||
| If you use `npm version`, it auto tags immediately after changing the version in package.json. In such case, you might want to specify the version manually and generate the changelog before `npm version`. | ||
| Please use this [gist](https://gist.github.com/stevemao/280ef22ee861323993a0) to make a release or change it to your needs. | ||
| ### With `npm version` | ||
| Using the npm scripts to our advantage with the following hooks: | ||
| ```json | ||
| { | ||
| "scripts": { | ||
| "version": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md" | ||
| } | ||
| } | ||
| ``` | ||
| You could follow the following workflow | ||
| 1. Make changes | ||
| 1. Commit those changes | ||
| 1. Pull all the tags | ||
| 1. Run the [`npm version [path|minor|major]`](https://docs.npmjs.com/cli/version) command | ||
| 1. Push | ||
| You could optionally add a `preversion` script to package your project or running a full suit of test. | ||
| And a `postversion` script to clean your system and push your release and tags. | ||
| By adding a `.npmrc` you could also automate your commit message and set your tag prefix as such: | ||
| ``` | ||
| tag-version-prefix="" | ||
| message="chore(release): %s :tada:" | ||
| ``` | ||
| ## Why | ||
@@ -90,5 +116,5 @@ | ||
| - [conventional-changelog](https://github.com/ajoslin/conventional-changelog) - API of this module | ||
| - [standard-changelog](https://github.com/conventional-changelog/standard-changelog) - Similar to this module but only with angular convention | ||
| - [standard-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/standard-changelog) - Similar to this module but only with angular convention | ||
| - [conventional-github-releaser](https://github.com/conventional-changelog/conventional-github-releaser) - Make a new GitHub release from git metadata | ||
| - [conventional-recommended-bump](https://github.com/conventional-changelog/conventional-recommended-bump) - Get a recommended version bump based on conventional commits | ||
| - [conventional-recommended-bump](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump) - Get a recommended version bump based on conventional commits | ||
| - [conventional-commits-detector](https://github.com/conventional-changelog/conventional-commits-detector) - Detect what commit message convention your repository is using | ||
@@ -95,0 +121,0 @@ - [commitizen](https://github.com/commitizen/cz-cli) - Simple commit conventions for internet citizens. |
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 by4.62%
17420
- Number of lines in readme file
- increased by23.64%
136