Skip to content
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

Wrong headings in CHANGELOG.md #3324

Open
kirrg001 opened this issue Sep 9, 2022 · 3 comments
Open

Wrong headings in CHANGELOG.md #3324

kirrg001 opened this issue Sep 9, 2022 · 3 comments

Comments

@kirrg001
Copy link

kirrg001 commented Sep 9, 2022

Current Behavior

Using Lerna latest version with the conventionalCommits: true in lerna.json.

The generated CHANGELOG.md contains multiple H1 headings.
https://raw.githubusercontent.com/lerna/lerna/main/CHANGELOG.md

conventional-changelog/conventional-changelog#440
conventional-changelog/conventional-changelog@3d79263

Expected Behavior

  • Features get h2
  • Patches get h3

Or in their newest update, they treat patches & features the same and use h2 only

conventional-changelog/conventional-changelog@d2e02d7
conventional-changelog/conventional-changelog#214
conventional-changelog/conventional-changelog#867

Steps to Reproduce

Add a feature commit & lerna version --no-push --no-git-tags and look the CHANGELOG.md

Environment

Lerna: 5.5.0

@ghiscoding
Copy link

ghiscoding commented Sep 12, 2022

That is not a Lerna bug but rather a conventional-changelog bug and the file you referenced is a template file but is not the default template, the default being changelog-angular (unless you provide a custom one) and so the file that you should really look into is this one conventional-changelog-angular/templates/header.hbs which does include h1 and h2. In other words, you should probably open an issue/PR on the conventional-changelog project. Basically, there's probably nothing that Lerna can do to fix your problem since Lerna just uses whatever template is returned from conventional-changelog which is outside of Lerna itself

@kirrg001
Copy link
Author

Ok I will raise the issue over there. My expectation was that Lerna needs to configure the usage of conventional-changelog-core by passing the correct options. But let's see, you might be right 👍

@kirrg001
Copy link
Author

I would love to fix this bug in https://github.com/conventional-changelog, but it looks like there is no active maintainer.

conventional-changelog/conventional-changelog#942

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants