docs: fix Conventional Commits PATCH rule #3628
Merged
Conversation
This file contains hidden or 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
asbjornu
approved these changes
Jul 21, 2023
Member
asbjornu
left a comment
asbjornu
left a comment
There was a problem hiding this comment.
I don't use conventional commits myself, but this looks reasonable to me.
Member
|
I think we should just set |
Contributor
Author
|
I didn't thoroughly test the theory, but I believe it's failing due to many of GitHub's "anchored" links not matching to an element's id attribute. That is, GitHub links "#L8" to line 8 of a given file via JavaScript and classes, but the HTML proofer is probably looking for something like |
If this is not respected in GitVersion's config... ...or if the revert rule is not overridden in semantic-release's config... ...then semantic-release may generate a different PATCH version than GitVersion.
…'s glob implementation
commitlint supports multiple scopes https://github.com/conventional-changelog/commitlint#what-is-commitlint
arturcic
force-pushed
the
bintoss/fixConventionalCommitPatchRule
branch
from
e0ce22e to
7a388f7
Compare
Contributor
|
Thank you @BinToss for your contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR changes the "Conventional Commit" RegEx to be more in line with Convention Commits 1.0.0 and commitlint specifications.
This PR also adds notes for configuring GitVersion and semantic-release to generate the same version.
I'm considering adding a separate section for the
angularcommit format since that is what semantic-release defaults to. It's...nearly identical to Conventional Commits, but is more concrete in its specifications e.g. a reverted commit's header (type(scope): header message) is to be the revert commit's header message.Related Issue
resolves #3627
Motivation and Context
I use GitVersion for stamping .NET assemblies and NuGet packages with version information, but I use semantic-release for git tags, release commits, change logs, release notes, GitHub releases, and more.
Because they both have commit analysis and version generation capabilities, I've found that ensuring both generate the same version can be quite finicky.
How Has This Been Tested?
https://regexr.com/7h6lv
Checklist: