New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
H1 heading in default template #942
Comments
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. 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):
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 I will look into a fix for that and create a PR asap. Any hints for me? |
@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:
|
cc @armano2 Will you help reviewing a PR for this bug? |
cc @bcoe Looking for someone who is actively reviewing pull requests & doing releases for this project. |
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:
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
Thanks!
The text was updated successfully, but these errors were encountered: