Prerelease uses branch name instead of tag name

[dagophil]

Prerequisites

• I have written a descriptive issue title
• I have searched issues to ensure it has not already been reported

GitVersion package

GitVersion.Tool

GitVersion version

6.4.0

Operating system

Linux

What are you seeing?

My git repo uses main as default branch and tags like v1.2.3 for versioning. Sometimes I want to create prereleases with the tags like v1.2.4-alpha0 and v1.2.4-alpha1, etc.

My preferred workflow:

• Create feature branch from main, e.g., feature/xyz.
• Work and do commits.
• When ready for public testing, I tag the feature branch with a prerelease tag, e.g., 1.2.4-alpha0.
• When running GitVersion now, it creates the SemVer 1.2.4-feature-xyz.1.

What is expected?

I expect the SemVer 1.2.4-alpha0 (or 1.2.4-alpha.0).

This used to work in earlier versions of GitVersion. (Maybe 5.12.0?)

I tried GitFlow, GitHubFlow, and TrunkBased workflows, but the output does not change.

The GitVersion.yml only contains the workflow.

If my scenario is not supported by the workflows, how can I configure GitVersion.yml to get the correct SemVers?

Steps to Reproduce

• Create repo with main branch.
• Add commit to main and tag it with v1.2.3.
• Create branch feature/xyz from main.
• Add commit to the branch and tag it with v1.2.4-alpha0.

RepositoryFixture Test

No response

Output log or link to your CI build (if appropriate).

[HHobeck]

I mean that's like it is configured, right? The label property of the gitflow workflow is set to {BranchName} for feature branches. Why do you expecting something else?

Have you already tried to set the label to null?

workflow: 'GitFlow/v1'
label:
branches:
  feature:
    label:

[HHobeck]

Please see the following integration test:

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

Lines 197 to 259 in aac25be

	public void EnsurePreReleaseTagLabelWillBeConsideredIfNoLabelIsDefined(long patchNumber)
	{
	var configuration = GitHubFlowConfigurationBuilder.New
	.WithLabel(null)
	.WithBranch("main", branchBuilder => branchBuilder
	.WithDeploymentMode(DeploymentMode.ManualDeployment)
	.WithLabel(null).WithIncrement(IncrementStrategy.Patch)
	).Build();
	using var fixture = new EmptyRepositoryFixture();
	fixture.MakeACommit();
	// ✅ succeeds as expected
	fixture.AssertFullSemver("0.0.1-1+1", configuration);
	fixture.ApplyTag($"0.0.{patchNumber}-alpha.1");
	// ✅ succeeds as expected
	fixture.AssertFullSemver($"0.0.{patchNumber}-alpha.1", configuration);
	fixture.MakeACommit();
	// ✅ succeeds as expected
	fixture.AssertFullSemver($"0.0.{patchNumber}-alpha.2+1", configuration);
	fixture.MakeACommit();
	// ✅ succeeds as expected
	fixture.AssertFullSemver($"0.0.{patchNumber}-alpha.2+2", configuration);
	fixture.MakeATaggedCommit($"0.0.{patchNumber}-beta.1");
	// ✅ succeeds as expected
	fixture.AssertFullSemver($"0.0.{patchNumber}-beta.1", configuration);
	fixture.MakeACommit();
	// ✅ succeeds as expected
	fixture.AssertFullSemver($"0.0.{patchNumber}-beta.2+1", configuration);
	fixture.MakeATaggedCommit($"0.0.{patchNumber}-beta.2");
	// ✅ succeeds as expected
	fixture.AssertFullSemver($"0.0.{patchNumber}-beta.2", configuration);
	fixture.MakeACommit();
	// ✅ succeeds as expected
	fixture.AssertFullSemver($"0.0.{patchNumber}-beta.3+1", configuration);
	fixture.ApplyTag($"0.0.{patchNumber}");
	// ✅ succeeds as expected
	fixture.AssertFullSemver($"0.0.{patchNumber}", configuration);
	fixture.MakeACommit();
	// ✅ succeeds as expected
	fixture.AssertFullSemver($"0.0.{patchNumber + 1}-1+1", configuration);
	fixture.Repository.DumpGraph();
	}

If you have a pre-release tag set to alpha then the pre-release tag will be only considered in this branch where the label is set to alpha as well (or null).

From the GitHub workflow point of view you need to consider:

• you are developing on the develop branch and producing alpha tags
• after your developing phase completes you are going to branch the develop branch to a release branch
• you are creating beta tags on the release branch and merge bug fixes from develop to release or vice versa
• on the develop branch it doesn't matter what pre-release tags are created on the release branch
• on the release branch it doesn't matter what pre-release tags are created on the develop branch

Hope that is understandable.

[HHobeck]

Clearing the label did not work. The tagged commit is still reported with the branch name.

If you still see the branch name then your configuration is not effecting or wrong.

[dagophil]

I made a typo in the yml. After fixing the typo, clearing the branch label did remove the branch name from the SemVer. Thank you for your help.

Thank you for clarifying the function of the different branches in the workflow. I did not know that the specific branch names are relevant. I thought that GitVersion treats all branches the same and just differentiates between "is tagged" -> "use that version" and "is not tagged" -> "find last tag and add increment".

Is it possible to configure GitVersion in the following way?

• Is the current commit tagged?
  • Yes: Use that version.
  • No:
    • Find version of last tagged commit.
    • Go to next version increment.
    • Use <versionincrement>-<branch-name>-<commit-sha> (or <versionincrement>-<branch-label>-<commit-sha>, if that is also possible).

[dagophil]

I think what I want is:

• Is the current commit tagged?
  • Yes: Use empty label.
  • No: Use branch name as label.

Is that possible?

[HHobeck]

I think what I want is:

• Is the current commit tagged?

  • Yes: Use empty label.
  • No: Use branch name as label.

Is that possible?

No, that is not possible as far as I know.