Pull Request Version Calculation Not Based on source branch

[anderson-dev]

Discussed in #2818

^{Originally posted by anderson-dev August 19, 2021}
I'm using mainline versioning mode where my feature branches increment by minor. In my scenario below, pull request version reflects the current version of master rather than the feature branch that the pull request is based on:

master
0.1.0
master -> feature/foo
commit
0.2.0-foo.1
feature/foo -> pull/8/merge
0.1.1-PullRequest00008.1
pull/8/merge -> master
0.2.0 (as expected)

I've tried changing the increment mode for pullrequests in my gitversion.yml branch config but it just changes the increment based on master. How would I tell it to simply take its version from the calculated version of the feature branch for which the pull request was created?

Find an integration test below, XenoLibPackages#CanCalculatePullRequestChanges, that reproduces my issue. I tried 'track-merge-target: true' with no dice.

using GitTools.Testing;
using GitVersion.Core.Tests.Helpers;
using GitVersion.Model.Configuration;
using GitVersion.VersionCalculation;
using LibGit2Sharp;
using NUnit.Framework;
using System.Collections.Generic;

namespace GitVersion.Core.Tests.IntegrationTests
{
    public class XenoLibPackages : TestBase
    {
        private readonly Config config = new Config
        {
            VersioningMode = VersioningMode.Mainline,
            Branches = new Dictionary<string, BranchConfig>
            {
                {
                    "feature", new BranchConfig
                    {
                        Increment = IncrementStrategy.Minor
                    }
                },
                {
                    "pull-request", new BranchConfig
                    {
                        Regex = @"^(pull|pull\-requests|pr)[/-]",
                        Increment = IncrementStrategy.None,
                        TrackMergeTarget = true
                    }
                }
            }
        };

        [Test]
        public void IncrementFeatureByMinor()
        {
            using var fixture = new EmptyRepositoryFixture();
            fixture.MakeATaggedCommit("0.1.0");

            // feature workflow
            fixture.BranchTo("feature/foo", "foo");
            fixture.MakeACommit();
            fixture.AssertFullSemver("0.2.0-foo.1", config);
            fixture.MakeACommit();
            fixture.AssertFullSemver("0.2.0-foo.2", config);
            fixture.Checkout(MainBranch);
            fixture.MergeNoFF("feature/foo");
            fixture.AssertFullSemver("0.2.0", config);
        }

        [Test]
        public void CanCalculatePullRequestChanges()
        {
            using var fixture = new EmptyRepositoryFixture();
            fixture.Repository.MakeATaggedCommit("0.1.0");
            Commands.Checkout(fixture.Repository, fixture.Repository.CreateBranch("feature/foo"));
            fixture.Repository.MakeACommit();
            fixture.AssertFullSemver("0.2.0-foo.1", config);

            fixture.Repository.CreatePullRequestRef("feature/foo", MainBranch, normalise: true);

            fixture.Repository.DumpGraph();
            fixture.AssertFullSemver("0.2.0-PullRequest0002.2");
        }
    }
}

[asbjornu]

Can you please submit a PR containing these tests?

[anderson-dev]

Can you please submit a PR containing these tests?

I submitted the pr 14 days ago. It was looked at but because the CI system treated the unit test failure as successful when it shouldn't it appears to have been ignored. It's there, if you look at the CI build system logs, you can see the test failure.

Is there something I'm missing or that would help in answering my question in how to support my intended branch strategy?

[anderson-dev]

Is there just no way to support the branch strategy I'm asking about? The PR was submitted 6 months ago with no suggestions. Does this need to be changed to a feature request rather than a simple question?

[asbjornu]

Sorry, but it has been an extremely hectic autumn and Christmas for me, but I've finally surfaced and have found some time to invest in GitVersion again. I've replied in #2830 (comment).

[anderson-dev]

thanks I've replied there as well

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. After 30 days from now, it will be closed if no further activity occurs.

[HHobeck]

public class XenoLibPackages : TestBase
{
    private readonly GitVersionConfiguration configuration = GitFlowConfigurationBuilder.New
        .WithVersioningMode(VersioningMode.Mainline)
        .WithBranch("feature", _ => _
            .WithIncrement(IncrementStrategy.Minor)
            .WithVersioningMode(VersioningMode.ContinuousDeployment)
        ).WithBranch("pull-request", _ => _
            .WithIncrement(IncrementStrategy.Inherit)
        ).Build();

    [Test]
    public void IncrementFeatureByMinor()
    {
        using var fixture = new EmptyRepositoryFixture();
        fixture.MakeATaggedCommit("0.1.0");

        fixture.BranchTo("feature/foo", "foo");
        fixture.MakeACommit();

        // ✅ succeeds as expected
        fixture.AssertFullSemver("0.2.0-foo.1", configuration);
        fixture.MakeACommit();

        // ✅ succeeds as expected
        fixture.AssertFullSemver("0.2.0-foo.2", configuration);
        fixture.Checkout("main");
        fixture.MergeNoFF("feature/foo");

        // ✅ succeeds as expected
        fixture.AssertFullSemver("0.2.0", configuration);
    }

    [Test]
    public void CanCalculatePullRequestChanges()
    {
        using var fixture = new EmptyRepositoryFixture();
        fixture.MakeATaggedCommit("0.1.0");
        fixture.BranchTo("feature/foo");
        fixture.MakeACommit();

        // ✅ succeeds as expected
        fixture.AssertFullSemver("0.2.0-foo.1", configuration);

        fixture.Repository.CreatePullRequestRef("feature/foo", "main", normalise: true);

        // ✅ succeeds as expected
        fixture.AssertFullSemver("0.2.0-PullRequest2.2", configuration);
    }
}

[arturcic]

🎉 This issue has been resolved in version 6.0.0-beta.2 🎉
The release is available on:

• GitHub Release
• Chocolatey Package
• .Net Global Tool

Your GitReleaseManager bot 📦🚀