conventional-changelog-conventionalcommits - npm Package Compare versions

Comparing version 4.3.0 to 4.3.1

CHANGELOG.md

		@@ -6,2 +6,14 @@ # Change Log

		## [4.3.1](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-changelog-conventionalcommits@4.3.0...conventional-changelog-conventionalcommits@4.3.1) (2020-06-20)


		### Bug Fixes

		* deps: update dependency compare-func to v2 ([#647](https://github.com/conventional-changelog/conventional-changelog/issues/647)) ([de4f630](https://github.com/conventional-changelog/conventional-changelog/commit/de4f6309403ca0d46b7c6235052f4dca61ea15bc))
		* pass config to parserOpts and writerOpts ([73c7a1b](https://github.com/conventional-changelog/conventional-changelog/commit/73c7a1b92c2a47c498f42972acbffa156172a341))





		# [4.3.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-changelog-conventionalcommits@4.2.3...conventional-changelog-conventionalcommits@4.3.0) (2020-05-08)
		@@ -8,0 +20,0 @@

conventional-changelog.js

		@@ -8,3 +8,3 @@ 'use strict'
		module.exports = function (config) {
		return Q.all([parserOpts, writerOpts])
		return Q.all([parserOpts(config), writerOpts(config)])
		.spread((parserOpts, writerOpts) => {
		@@ -11,0 +11,0 @@ return { parserOpts, writerOpts }

package.json

		{
		"name": "conventional-changelog-conventionalcommits",
		"version": "4.3.0",
		"version": "4.3.1",
		"description": "conventional-changelog conventionalcommits.org preset",
		@@ -37,7 +37,7 @@ "main": "index.js",
		"dependencies": {
		"compare-func": "^1.3.1",
		"compare-func": "^2.0.0",
		"lodash": "^4.17.15",
		"q": "^1.5.1"
		},
		"gitHead": "83643c5a0d2c4d7c9ba14cbf990ffbc577a51e8c"
		"gitHead": "3dedddc397e7cbcf5a2ff971ca933992b9e4d11f"
		}

README.md

		@@ -9,2 +9,36 @@ # [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url]


		## Indirect Usage (as preset)

		Use the [Conventional Changelog CLI Quick Start](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli#quick-start) with the `-p conventionalcommits` option.

		## Direct Usage (as a base preset so you can customize it)

		If you want to use this package directly and pass options, you can use the [Conventional Changelog CLI Quick Start](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli#quick-start) and with the `--config` or `-n` parameter, pass a js config that looks like this
		```
		'use strict'
		const config = require('conventional-changelog-conventionalcommits')

		module.exports = config({
		"issuePrefixes": ["TEST-"],
		"issueUrlFormat": "myBugTracker.com/{prefix}{id}"
		})
		```

		or json config like that:
		```
		{
		"options": {
		"preset": {
		"name": "conventionalchangelog",
		"issuePrefixes": ["TEST-"],
		"issueUrlFormat": "myBugTracker.com/{prefix}{id}"
		}
		}
		}
		```
		This last json config way passes the `preset` object to the `conventional-changelog-preset-loader` package, that in turn, passes this same `preset` object as the config for the `conventional-changelog-conventionalcommits`.



		See [conventional-changelog-config-spec](https://github.com/conventional-changelog/conventional-changelog-config-spec) for available
		@@ -11,0 +45,0 @@ configuration options.

New alerts