Docs: Describe configuration for using Conventional commits #2553
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
|
can you rebase on top of main? |
The added tests will validate whether more complex version bump commit scenario's are processes correctly.
Also added tests to ensure this will keep working
I added this earlier but then decided to create a new test alltogether
AlexGoris-KasparSolutions
force-pushed
the
conventional-commits
branch
from
73a3af2 to
045b9fe
Compare
Done |
asbjornu
approved these changes
Feb 1, 2021
|
Thank you so much for providing this, @AlexGoris-KasparSolutions! 🙏🏼 |
|
🎉 This issue has been resolved in version 5.6.5 🎉 Your GitReleaseManager bot 📦🚀 |
|
The syntax for breaking changes is incorrect.
Also, a body is optional. I'm no regex(pert) (yeah I did that :P ) but I think this should solve it: |
|
Pull requests are welcome, @Fresa! 🙏🏼 |
5 tasks
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.
This change adds a chapter to the docs which describes how to configure GitVersion for using it with conventional commits
Description
Using the
*-version-bump-messageconfiguration, I created some regex's which work for the conventional commit standard.Related Issue
Contributing guidelines didn't mention an open issue would be needed for documentation changes, do I need one?
Motivation and Context
I've been a long time fan of this project (thanks guys! ❤), but since I started using conventional commits last year I've always struggled with keeping the configuration as simple as possible, at best this involved the use of GitVersion with several other tools chained together. This way I can finally use just a simple
GitVersion.ymlin my repo's and have my builds versioned accordingly.I imagine there are others like me out there, so hopefully it will be of use to someone.
How Has This Been Tested?
I added tests which test various conventional commit scenarios I could come up with.
Checklist: