Changelog header is not working

[nqdrizzt]

I am trying to generate a conventional changelog via cli.
I use the following config file and call the command via cli on linuux:

root@c9b3263bdfd0:/build# cat .conventional-changelog.json

{
    "options": {
        "preset": {
            "name": "conventionalcommits",
            "header": "Awesome Changelog",
            "types": [
                {"type": "feat", "section": "Features"},
                {"type": "fix", "section": "Bug Fixes"},
                {"type": "chore", "section": "Chore"},
                {"type": "docs", "section": "Documentation"},
                {"type": "style", "hidden": true},
                {"type": "refactor", "section": "Refactoring"},
                {"type": "perf", "hidden": true},
                {"type": "test", "hidden": true}
            ]
        }
    }
}

root@c9b3263bdfd0:/build# conventional-changelog --config .conventional-changelog.json -i CHANGELOG.md -s -r 0 -u

The resulting changelog looks like this:
As you can see here, the Level 1 heading "Awesome Changelog" sepcified in the config above is missing. Am I doing something wrong here or is this a bug ?
The setting is documented here

1.3.0 (2023-01-13)

⚠ BREAKING CHANGES

• CICD: not compatible

Features

• CICD: automatic changelog generation [skip ci] (d710ee1)

Bug Fixes

• CICD: missing package.json for version handling [skip ci] (a14ac19)

Chore

• CICD: added changelog file [skip ci] (caf7b64)

1.2.0 (2023-01-13)

Features

[davidwallis3101]

did you ever resolve this, I'm seeing the same issue

[rickh18]

I had te same issue when using release-it. I moved the header setting in the json one level up, so under options instead off preset :

{
    "options": {
        "header": "Awesome Changelog",
        "preset": {
            "name": "conventionalcommits",
            "types": [
                {"type": "feat", "section": "Features"},
                {"type": "fix", "section": "Bug Fixes"},
                {"type": "chore", "section": "Chore"},
                {"type": "docs", "section": "Documentation"},
                {"type": "style", "hidden": true},
                {"type": "refactor", "section": "Refactoring"},
                {"type": "perf", "hidden": true},
                {"type": "test", "hidden": true}
            ]
        }
    }
}

This worked in my case. Docs are not very clear on this part.

[nqdrizzt]

I am using git-cliff now to generate my changelogs. it works just flawless and its also highly customizable

[davidwallis3101]

Will take a look thanks

…

On Wed, 17 Apr 2024 at 20:47, nqdrizzt ***@***.***> wrote: I am using git-cliff now to generate my changelogs. it works just flawless and its also highly customizable — Reply to this email directly, view it on GitHub <#955 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADJWV7XJ27F6QGGNYU5BU3DY53GVNAVCNFSM6AAAAAAT2SBMHSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANRSGA4TINZRHA> . You are receiving this because you commented.Message ID: <conventional-changelog/conventional-changelog/issues/955/2062094718@ github.com>

[davidwallis3101]

I tried this, and have switched, does everything I needed. Thanks

…

On Wed, 17 Apr 2024 at 20:47, nqdrizzt ***@***.***> wrote: I am using git-cliff now to generate my changelogs. it works just flawless and its also highly customizable — Reply to this email directly, view it on GitHub <#955 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADJWV7XJ27F6QGGNYU5BU3DY53GVNAVCNFSM6AAAAAAT2SBMHSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANRSGA4TINZRHA> . You are receiving this because you commented.Message ID: <conventional-changelog/conventional-changelog/issues/955/2062094718@ github.com>