H1 heading in default template

Current Behavior

We are using the latest Lerna 5.5 version, which generates a CHANGELOG.md based on conventional commits. But the generated CHANGELOG.md contains multiple H1 headings. I first raised the issue in Lerna, but they sent me here.

Lerna is using conventional-changelog-core internally.

Heading was already fixed in conventional-changelog:

• https://github.com/conventional-changelog/conventional-changelog/pull/440
• https://github.com/conventional-changelog/conventional-changelog/commit/3d792639815e4c4ae7758e0e84ba72a9cb535f37
• https://github.com/conventional-changelog/conventional-changelog/commit/d2e02d73f275bd10a39c52016999d8faf400c990
• https://github.com/conventional-changelog/conventional-changelog/issues/214
• https://github.com/conventional-changelog/conventional-changelog/issues/867

But it looks like the default template is still using H1: https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/templates/header.hbs

Expected Behavior

• Features get H2
• Patches get H3 (or even H2 too)

Thanks!

[kleinfreund]

Agreed. This is bugging me as well. Additionally it would be nice if there would always be an h1 at the start of the changelog file (e.g. # Changelog).

I just want to point out that the headings for versions should always be level 2 headings like so:

# Changelog

## 4.1.1

### Bug fixes

## 4.1.0

### Features

Headings for versions should not change in level depending on what kind of release it is because that leads to a broken outline. The following doesn’t make sense – the level 3 heading “4.1.1” structurally follows the level 1 heading “Changelog” so it skips a level without cause.

# Changelog

### 4.1.1

### Bug fixes

## 4.1.0

### Features

It’s perhaps easier to visualize a document outline as a nested list (a table of contents if you will):

• Changelog
  • 4.1.1
    • Bug fixes
  • 4.1.0
    • Features

Note how this structure makes it impossible to make 4.1.1 a third-level list because there isn’t a second-level list it could belong to.

[kleinfreund]

@kirrg001 That’s great! I’m not familiar with this project, but I reckon looking at the following files is going to be pretty relevant:

• https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/templates/header.hbs
• https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/templates/commit.hbs
• https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/templates/footer.hbs