Changelog title

[stalniy]

Issue:

In my Changelog.md I have title but each new version logs are just added on the top of it. Thus title moves at the middle of the file

Expected:

I'd like my title to be always on top

Possible solutions:

Check if the first line of the file starts from # and if it's, add notes under title

[pvdlg]

The problem is there is not really a standard to format changelogs. Detecting if the first line start with # can be very error prone if there is no title for the changelog file, the first line will be the first line of the last release, which can starts with # (or really anything as the format is completely customizable).

For info this how conventional-changelog do it: https://github.com/conventional-changelog/standard-version/blob/master/lib/lifecycles/changelog.js#L20. It's not great either as it works only for a specific title.

Ideally what we need would be:

• A specification of changelog file format (with title, separator etc...)
• An external project that provides an API to generate and change a changelog file

[stalniy]

We could check that the first line starts with # (space after #) + add additional option something like hasTitle. That would be a good first step

[stalniy]

Or option may look like this

title: { lines: 3, startsWith: ‘# ‘ }

Or just pass in the whole title (similar to how we can pass commit message for git plugin)

title: ‘# My Awesome title'

[stalniy]

The plugin will look for the title at the beginning of file, basically calling content.trim().startsWith(options.title) if exists we can just slice out the title length options.title + content.slice(options.title.length)

I can work on PR if you like this

[stalniy]

any updates?

[pvdlg]

Sorry for the late response. We could add the changelogTitle option as you suggested.
You would need all cases though:

• a CHANGELOG.md exists with a title and some content
• a CHANGELOG.md exists with a title only
• a CHANGELOG.md exists with content but no title => Not sure what the proper way to handle that, probably add the title to the file?
• a CHANGELOG.md doesn't exists => Creates it with the title

[semantic-release-bot]

🎉 This issue has been resolved in version 2.1.0 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀