fix(conventionalcommits): always use h2 #787
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mesteery
force-pushed
the
patch-1
branch
2 times, most recently
from
7674543
to
4dfa5ce
Compare
Now H2 is used all the time whether it is a patch or not. Before an H3 was used when it was a patch, but this is bad, because what is supposed to be the title is of the same level as its content (the changelogs sections), so the title (when it was a patch) was hardly differentiable from its content (same title level: H3). Moreover it could avoid bugging tools that are based on the title level.
|
@Mesteery this would be a breaking change. Perhaps you could instead pass in a custom template for your use case? |
|
Yes and no. It's for release-please. |
|
@Mesteery funny enough, I think for release-please we pass our own templates, so this wouldn't actually correct the template in its case. |
|
https://github.com/googleapis/release-please/blob/37f4ec236be3bd99e74162a0cc16acd47042528f/src/conventional-commits.ts#L206 is using |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Now H2 is used all the time whether it is a patch or not.
Before an H3 was used when it was a patch, but this is bad, because what is supposed to be the title is of the same level as its content (the changelogs sections), so the title (when it was a patch) was hardly differentiable from its content (same title level: H3).
Moreover it could avoid bugging tools that are based on the title level.