conventional-changelog-conventionalcommits: Patch version headings shouldn’t be a different size

[shivjm]

Same as #214, but for conventional-changelog-conventionalcommits. Heading levels indicate a structure. Patch versions should use ## <small> instead of ### , as @marcysutton pointed out.

[trallnag]

Is this a regression? The following link points to a changelog where the heading level structure is correct. Scroll down a bit to see patch releases.

• https://github.com/oleg-koval/semantic-release-npm-github-publish/blob/master/CHANGELOG.md

His package.json looks quite different from mine:

• https://github.com/oleg-koval/semantic-release-npm-github-publish/blob/master/package.json

I also noticed the heading level structure and posted about it here semantic-release/semantic-release#2312.

[shivjm]

The following link points to a changelog where the heading level structure is correct. Scroll down a bit to see patch releases.

• https://github.com/oleg-koval/semantic-release-npm-github-publish/blob/master/CHANGELOG.md

Sorry, I’m not sure I follow—all the releases there seem to follow the incorrect pattern of smaller headings for patch versions and larger headings for major versions. 😖

[trallnag]

@shivjm, okay I see what you mean. His changelog:

• # for major and minor releases
• ## for patch releases
• ### for "types" (bugs, features, ...)

In my changelog:

• ## for major and minor releases
• ### for patch releases
• ### for "types" (bugs, features, ...)

[shivjm]

Correct, that’s the current situation. What I’m talking about is changing it to always use ## and add <small> for patch releases.

[trallnag]

I agree

[languitar]

Actually, the whole idea of using higher-level headings for major releases is a bit strange here, because a heading in a text document is meant for what follow below. However, with the reverse sorting, the structure created here puts the previous releases into the section created by the next version, e.g.:

## 2.1.0

# 2.0.0

## 1.5.18

## 1.5.17

Why are 1.5.17 and 1.5.18 part of the section opened by the 2.0.0 heading. That doesn't make any sense with this sorting.

[kleinfreund]

Even without reverse sorting, it doesn’t make sense to use subordinate heading levels for minor or patch versions. Version 2.0.1 does not belong to or is not a part of version 2.0.0. They are simply separate versions of which 2.0.1 is the newer one. Version 2.0.1 can be considered a part of some notion of a version 2 release line, but there are no sections for such a thing in the changelog templates referenced here. The sections are always for exact versions associated with an individual release and should therefore all have the exact same heading level.

[chalkygames123]

Thank you all. I've been waiting for this fix!