standard-version icon indicating copy to clipboard operation
standard-version copied to clipboard

Style of CHANGELOG.md

Open parohy opened this issue 2 years ago • 4 comments

How are the release headers style chosen?

We are runningcouple of release notes scripts after creating CHANGELOG. We have noticed, that some of the release headers in CHANGELOG are H3 ### and some are H2 ##. It doesn't make sense to us, because we are talking about same level release. Example:

[1.1.0]

[1.0.1]

[1.0.0]

Same inconsistency we can find in all releases regardless if its patch/minor/major.

parohy avatar Jan 17 '22 09:01 parohy

I am also facing this same issue. I am using version 9.3.2.

While trying to use this tool along with changelog-parser some versions are not showing because some of them are using ### instead of ##.

Here is an example of the generated CHANGELOG.md after creating a new release with a single bug fix:


### [14.3.1](URL) (2022-01-28)


### Bug Fixes

...

## [14.3.0](URL) (2022-01-28)


### Features

...


### Bug Fixes

...

goalves avatar Jan 28 '22 17:01 goalves

just noticed this as well :+1: would be great to know if this is intentional or a bug...

acidicX avatar Feb 07 '22 10:02 acidicX

also wondering

jk195417 avatar Mar 22 '22 05:03 jk195417

Looks like a bug honestly but it is fixable by adding some postchangelog hook:

    "scripts": {
      "postchangelog": "replace \"### \\[\" \"## \\[\" CHANGELOG.md"
    }

I didn't have time to dig deeper into the codebase to properly fix it as it appears that the #'s are generated from another codebase

goalves avatar Mar 22 '22 17:03 goalves