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

feat: changelog-header configuration #15

Closed bcoe closed 5 years ago

bcoe commented 5 years ago

For standard-version, I would like to provide users with a changelog-header configuration option, which lets them customize the header in the CHANGELOG they're generating.

jbottigliero commented 5 years ago

Proposed as:

        "header": {
            "type": "string",
            "description": "A string to be used as the main header section of the CHANGELOG.",
            "default": "# Changelog\n\n"
        },

I didn't go 1:1 with the fallback in standard-version for the default here... I would be open to switching it, I think it just comes down to whether or not the defaults found in the spec are expected to be the defaults for the conventionalcommits preset.

jbottigliero commented 5 years ago

I've gone ahead and added header in version 2.0.0 of the spec.