Merge pull request #2553 from AlexGoris-KasparSolutions/conventional-commits

Docs: Describe configuration for using Conventional commits

Author: asbjornu

docs/input/docs/more-info/version-increments.md

@@ -84,6 +84,20 @@ One thing to be aware of: If the current version is an alpha-version
 (eg from 0.2.0 to 0.3.0 instead of 1.0.0). Once the current version is greater
 than 1.0.0, bumping the major version works as expected.
 
+#### Conventional commit messages
+
+If you want to use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+standard, you can leverage this feature as follows:
+
+```yaml
+mode: MainLine # Only add this if you want every version to be created automatically on your main branch.
+major-version-bump-message: "(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\\([\\w\\s]*\\))?(!:|:.*\\n\\n.*\\n\\n.*BREAKING.*).*"
+minor-version-bump-message: "(feat)(\\([\\w\\s]*\\))?:"
+patch-version-bump-message: "(build|chore|ci|docs|fix|perf|refactor|revert|style|test)(\\([\\w\\s]*\\))?:(.*\\n\\n.*\\n\\n.*BREAKING.*){0}"
+```
+
+This will ensure that your version gets bumped according to the commits you've created.
+
 ### GitVersion.yml
 
 The first is by setting the `next-version` property in the GitVersion.yml file.

src/GitVersion.Core.Tests/IntegrationTests/VersionBumpingScenarios.cs

@@ -48,6 +48,50 @@ public void CanUseCommitMessagesToBumpVersion()
             fixture.AssertFullSemver("2.0.0+2");
         }
 
+        [Test]
+        public void CanUseConventionalCommitsToBumpVersion()
+        {
+            var configuration = new Config
+            {
+                VersioningMode = GitVersion.VersionCalculation.VersioningMode.Mainline,
+
+                // For future debugging of this regex: https://regex101.com/r/UfzIwS/1
+                MajorVersionBumpMessage = "(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\\([\\w\\s]*\\))?(!:|:.*\\n\\n.*\\n\\n.*BREAKING.*).*",
+
+                // For future debugging of this regex: https://regex101.com/r/9ccNam/1
+                MinorVersionBumpMessage = "(feat)(\\([\\w\\s]*\\))?:",
+
+                // For future debugging of this regex: https://regex101.com/r/ALKccf/1
+                PatchVersionBumpMessage = "(build|chore|ci|docs|fix|perf|refactor|revert|style|test)(\\([\\w\\s]*\\))?:(.*\\n\\n.*\\n\\n.*BREAKING.*){0}"
+            };
+            using var fixture = new EmptyRepositoryFixture();
+            fixture.Repository.MakeACommit();
+            fixture.MakeATaggedCommit("1.0.0");
+
+            fixture.Repository.MakeACommit("feat(Api): Added some new endpoints");
+            fixture.AssertFullSemver("1.1.0", configuration);
+
+            // This tests if adding an exclamation mark after the type (breaking change) bumps the major version
+            fixture.Repository.MakeACommit("feat(Api)!: Changed existing API models");
+            fixture.AssertFullSemver("2.0.0", configuration);
+
+            // This tests if writing BREAKING CHANGE in the footer bumps the major version
+            fixture.Repository.MakeACommit("feat: Changed existing API models\n\nSome more descriptive text\n\nBREAKING CHANGE");
+            fixture.AssertFullSemver("3.0.0", configuration);
+
+            fixture.Repository.MakeACommit("chore: Cleaned up various things");
+            fixture.AssertFullSemver("3.0.1", configuration);
+
+            fixture.Repository.MakeACommit("chore: Cleaned up more various things");
+            fixture.AssertFullSemver("3.0.2", configuration);
+
+            fixture.Repository.MakeACommit("feat: Added some new functionality");
+            fixture.AssertFullSemver("3.1.0", configuration);
+
+            fixture.Repository.MakeACommit("feat: Added even more new functionality");
+            fixture.AssertFullSemver("3.2.0", configuration);
+        }
+
         [Test]
         public void CanUseCommitMessagesToBumpVersionBaseVersionTagIsAppliedToSameCommit()
         {