Commit message incrementing precedence

[joeshadbolt]

Hello,

We have been using GitVersion for a while, for what mostly resembles a trunk based branching strategy, using Azure pipelines and making use of the GitTools ADO extension.

Now we are attempting to do 2 things; upgrade to version 6 (been running 5.12) and make some small improvements to our configuration.

We are observing some behaviour and aren't quite sure if this is expected behaviour or not and so would like some input.

Given the below GitVersion configuration, noting the main branch has a default increment of Minor, when the merge commit from a PR contains +semver: patch the version increment is still minor. We appear to only be able to successfully influence the version increment via commit message when using +semver: major otherwise the branch increment seems to take precedence.

Note - this is not the entire config for brevity.

...
major-version-bump-message: \+semver:\s?(breaking|major)
minor-version-bump-message: \+semver:\s?(feature|minor)
patch-version-bump-message: \+semver:\s?(fix|patch)
strategies:
  - ConfiguredNextVersion
  - TaggedCommit
  - Mainline
branches:
  main:
    mode: ContinuousDeployment
    label: ''
    increment: Minor
    prevent-increment:
      of-merged-branch: false
    track-merge-target: false
    track-merge-message: true
    regex: ^master$|^main$
    source-branches: []
    is-source-branch-for: []
    tracks-release-branches: false
    is-release-branch: false
    is-main-branch: true
    pre-release-weight: 55000
    ...

Is this as per design? Is there a way we can override for desired behaviour?

Thanks!

[HHobeck]

Well you have set the prevent-increment-of-merged-branch property to false. Thus the answer is yes. Set it to true.

Just to notice: This property is true in the TrunkBased/preview1 workflow per default.

Link[1]: https://gitversion.net/docs/reference/configuration#snippet-/docs/workflows/TrunkBased/preview1.yml

[joeshadbolt]

Ok thanks for your reply. That's interesting, I think if I understand that particular configuration item's purpose, I would wonder then why +semver: major does in fact override the increment behaviour, as that is still the merge commit message.

To the second part of my question, my desired behaviour is main to increment by default Minor, yet should the merge commit message contain an increment instruction e.g. +semver: patch, that commit message would override the branch increment default behaviour.

I am unclear as to the combination of configuration properties to achieve this. Simply setting prevent-increment-of-merged-branch
to true does not appear to have the desired outcome.

[HHobeck]

Please provide a minimal scenario and steps to reproduce with actual and expected result.

By creating an integration test or providing git commands.

[joeshadbolt]

I have attempted the following integration test, kudos to the framework for making that so easy.

Configuration:

private static GitFlowConfigurationBuilder GetConfigurationBuilder() => GitFlowConfigurationBuilder.New
        .WithVersionStrategy(VersionStrategies.Mainline)
        .WithCommitMessageIncrementing(CommitMessageIncrementMode.Enabled)
        .WithBranch("main", builder => builder
            .WithIsMainBranch(true).WithIncrement(IncrementStrategy.Minor)
            .WithDeploymentMode(DeploymentMode.ContinuousDeployment)
            .WithPreventIncrementOfMergedBranch(true)
            .WithTrackMergeMessage(true)
            .WithTrackMergeTarget(false)
            .WithSourceBranches()
        )
        .WithBranch("feature", builder => builder
            .WithIsMainBranch(false).WithIncrement(IncrementStrategy.Minor)
            .WithDeploymentMode(DeploymentMode.ContinuousDelivery)
            .WithSourceBranches("main")
        );

Expected outcome of test:

• main branch by default with no commit message instruction, will increment minor
• If merge commit message contains commit message instruction, increment will be determined by commit message.

[Test]
    public void MergedFeatureBranchToMainWithPatchCommitMessageTag()
    {
        var configuration = GetConfigurationBuilder().Build();

        using var fixture = new EmptyRepositoryFixture();
        fixture.Repository.MakeACommit("1");
        fixture.MakeATaggedCommit("1.0.0");

        fixture.BranchTo("feature/foo", "foo");
        fixture.MakeACommit("2");
        fixture.AssertFullSemver("1.1.0-foo.1", configuration);
        fixture.Checkout(MainBranch);
        fixture.MergeNoFF("feature/foo");

        fixture.AssertFullSemver("1.1.0", configuration);

        fixture.BranchTo("feature/foo1", "foo1");
        fixture.MakeACommit("3");
        fixture.Checkout(MainBranch);
        fixture.MergeNoFF("feature/foo1");
        fixture.SequenceDiagram.NoteOver("Merge message contains '+semver: major'", MainBranch);
        
        var commit = fixture.Repository.Head.Tip;
        // Put semver increment in merge message
        fixture.Repository.Commit(commit.Message + " +semver: major", commit.Author, commit.Committer, new() { AmendPreviousCommit = true });
        fixture.AssertFullSemver("2.0.0", configuration);

        fixture.BranchTo("feature/foo2", "foo3");
        fixture.MakeACommit("4");
        fixture.Checkout(MainBranch);
        fixture.MergeNoFF("feature/foo2");
        fixture.SequenceDiagram.NoteOver("Merge message contains '+semver: patch'", MainBranch);
        
        commit = fixture.Repository.Head.Tip;
        // Put semver increment in merge message
        fixture.Repository.Commit(commit.Message + " +semver: patch", commit.Author, commit.Committer, new() { AmendPreviousCommit = true });
        fixture.AssertFullSemver("2.0.1", configuration);
    }

Note - I have included the example of major, which does appear to be taken into consideration.

Thanks!

[HHobeck]

Your feature branch is minor. You cannot downgrade the increment in version 6.x. The documentation (breaking change) states:

The Mainline version strategy doesn't support downgrading the increment for calculating the next version. This is the case if e.g. a bump messages has been defined which is lower than the branch increment.

Please see also:

• [FEATURE]: Support of '=semver: none|minor|major|patch' bump message to suppress the version increment #4144