conventional-changelog-action/node_modules/conventional-changelog-conv...
Conventional Changelog Action 7f7af7582e chore(release): v3.4.1 2020-10-30 22:27:33 +00:00
..
templates chore(release): v3.4.1 2020-10-30 22:27:33 +00:00
CHANGELOG.md chore(release): v3.4.1 2020-10-30 22:27:33 +00:00
LICENSE.md chore(release): v3.1.1 2020-07-13 17:58:28 +00:00
README.md chore(release): v3.4.1 2020-10-30 22:27:33 +00:00
add-bang-notes.js chore(release): v3.1.1 2020-07-13 17:58:28 +00:00
conventional-changelog.js chore(release): v3.4.1 2020-10-30 22:27:33 +00:00
conventional-recommended-bump.js chore(release): v3.1.1 2020-07-13 17:58:28 +00:00
index.js chore(release): v3.1.1 2020-07-13 17:58:28 +00:00
package.json chore(release): v3.4.1 2020-10-30 22:27:33 +00:00
parser-opts.js chore(release): v3.1.1 2020-07-13 17:58:28 +00:00
writer-opts.js chore(release): v3.1.1 2020-07-13 17:58:28 +00:00

README.md

Build Status Coverage Status

conventionalcommits.org convention

A concrete implementation of the specification described at conventionalcommits.org for automated CHANGELOG generation and version management.

Indirect Usage (as preset)

Use the 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 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 for available configuration options.