Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

header option in .versionrc is ignored #407

Open
matatk opened this issue Jul 22, 2019 · 3 comments
Open

header option in .versionrc is ignored #407

matatk opened this issue Jul 22, 2019 · 3 comments

Comments

@matatk
Copy link

matatk commented Jul 22, 2019

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.

@jbottigliero
Copy link
Member

Hey @matatk – while standard-version uses the conventional-changelog-config-spec@2.0.0, support for the new header property hasn't hit a release, yet.

#364 should implement the functionality you are looking for – if you want to give that branch try.

@matatk
Copy link
Author

matatk commented Jul 24, 2019

@jbottigliero thanks for your quick and helpful replies (on this issue and the other one I filed). I've just tried the "feat-header-support" branch from #364 and it does indeed work as expected :-).

@TheEvilDev
Copy link

This sort of works on the main release it's just under a different value:

"changelogHeader": "# Custom Header",

(Using version 7.0.0)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

3 participants