README.md

Conventional Changelog Configuration Spec (v2.1.0)

Structure

• header
• types
  • type
• preMajor
• commitUrlFormat
• compareUrlFormat
• issueUrlFormat
• userUrlFormat
• releaseCommitMessageFormat
• issuePrefixes

Substitutions

• host
• owner
• repository
• hash
• previousTag
• currentTag

---

header (string)

A string to be used as the main header of the CHANGELOG.

Changelog

types

An array of type objects representing the explicitly supported commit message types, and whether they should show up in generated CHANGELOGs.

"types": [
    {"type": "feat", "section": "Features"},
    {"type": "fix", "section": "Bug Fixes"},
    {"type": "chore", "hidden": true},
    {"type": "docs", "hidden": true},
    {"type": "style", "hidden": true},
    {"type": "refactor", "hidden": true},
    {"type": "perf", "hidden": true},
    {"type": "test", "hidden": true}
]

type

name	type	required	default	description
type	string	✔️	N/A	A string used to match <type>s used in the Conventional Commits convention.
section	string	✖️	N/A	The section where the matched commit type will display in the CHANGELOG.
hidden	boolean	✖️	N/A	Set to true to hide matched commit types in the CHANGELOG.

preMajor (boolean)

Boolean indicating whether or not the action being run (generating CHANGELOG, recommendedBump, etc.) is being performed for a pre-major release (<1.0.0).

This config setting will generally be set by tooling and not a user.

commitUrlFormat (string)

A URL representing a specific commit at a hash.

{{host}}/{{owner}}/{{repository}}/commit/{{hash}}

See Substitutions for more details on substitutions.

compareUrlFormat (string)

A URL representing the comparison between two git shas.

{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}

See Substitutions for more details on substitutions.

issueUrlFormat (string)

A URL representing the issueformat (allowing a different URL format to be swapped in for Gitlab, Bitbucket, etc):

{{host}}/{{owner}}/{{repository}}/issues/{{id}}

See Substitutions for more details on substitutions.

userUrlFormat (string)

A URL representing the a user's profile URL on GitHub, Gitlab, etc. This URL is used for substituting @bcoe with https://github.com/bcoe in commit messages.

{{host}}/{{user}}

See Substitutions for more details on substitutions.

releaseCommitMessageFormat (string)

A string to be used to format the auto-generated release commit message.

chore(release): {{currentTag}}

See Substitutions for more details on substitutions.

issuePrefixes (array of string)

An array of prefixes used to detect references to issues

['#']

Substitutions

All substitutions use Handlebar syntax and templating and will be interpolated as a string.

{{host}}

Default: Normalized host found in package.json.

Available to: commitUrlFormat, compareUrlFormat, issueUrlFormat

{{owner}}

Default: Extracted from normalized package.json repository.url field.

Available to: commitUrlFormat, compareUrlFormat, issueUrlFormat

{{repository}}

Default: Extracted from normalized package.json repository.url field.

Available to: commitUrlFormat, compareUrlFormat, issueUrlFormat

{{hash}}

Default: The commit hash of the tagged release.

Available to: commitUrlFormat

{{previousTag}}

Default: Previous semver tag or the first commit hash if no previous tag is available.

Available to: compareUrlFormat

{{currentTag}}

Default: Current semver tag or or 'v' + version if no current tag is available.

Available to: compareUrlFormat

{{user}}

Default: username to the right-hand-side of the @ symbol in @user shorthand.

Available to: userUrlFormat