.versionrc.json 2.1.0 (SchemaStore) JSON Schema

Schema URL

https://catalog.lintel.tools/schemas/schemastore/versionrc-json/versions/2.1.0.json

← Back to .versionrc.json

Type: object

Describes the configuration options supported by conventional-config for upstream tooling.

Properties

header string

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

Default:

"# Changelog

"

types type[]

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

Default:

[
  {
    "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
  }
]

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.

Default: false

commitUrlFormat string

A URL representing a specific commit at a hash.

Default: "{{host}}/{{owner}}/{{repository}}/commit/{{hash}}"

compareUrlFormat string

A URL representing the comparison between two git SHAs.

Default: "{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}"

issueUrlFormat string

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

Default: "{{host}}/{{owner}}/{{repository}}/issues/{{id}}"

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.

Default: "{{host}}/{{user}}"

releaseCommitMessageFormat string

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

Default: "chore(release): {{currentTag}}"

issuePrefixes string[]

An array of prefixes used to detect references to issues

Default:

[
  "#"
]

Definitions

type object

An object that describes a commit type's settings in the CHANGELOG

type string required

A string used to match s used in the Conventional Commits convention.

section string

The section where the matched commit type will display in the CHANGELOG.

hidden boolean

Set to true to hide matched commit types in the CHANGELOG.