Skip to content

header option in .versionrc is ignored #407

Open
@matatk

Description

@matatk

I'm using a .versionrc file to specify options, and this is taken into consideration by standard-version (I checked this by setting the "feat" commit type to hidden and it worked).

However, the "changelogHeader" or "header" options are ignored. I wasn't entirely clear whether the option should be specified as "changelogHeader" (as the standard-version README says you can put command-line options into the file) or "header" (as per the conventional-commits-config-spec 2.0.0). Either way, it doesn't seem to set the header in the generated CHANGELOG.md file.

Example .versionrc:

{
  "header": "This header is not used"
}

The CHANGELOG.md file begins...

# Changelog

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## 0.1.0 (2019-07-22)
. . .

I would've expected the first line to be

# This header is not used

I'm using standard-version 6.0.1.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions