search

conventional-changelog / conventional-changelog-config-spec

a spec describing the config options supported by conventional-config for upstream tooling
110 stars 31 forks source link

Missing option #32

Open ghost opened 4 years ago

ghost commented 4 years ago

I was looking for a way to customise the message that appears at the top of the changelog and found the changelogHeader option.

This doesn't appear to be documented anywhere; has it just been forgotten or is it deprecated or something?

I mention it because I'm using the standard-version package. Perhaps this is just a command line argument that isn't actually part of the spec though?

jbottigliero commented 4 years ago

Hi @jakelucas, in my eyes --changelogHeader is on its way to being deprecated in standard-version.

I'd like to get things moved over to the spec's header option, it just hasn't been included... yet. The work on the change stalled for a bit (conventional-changelog/standard-version#364), but I'll see what I can do to get it wrapped up to avoid confusion.

My goal is to make the change backward-compatible with the usage of --changelogHeader and only fully deprecate the usage of that option in the next major version, whatever that may be.