GitVersion on Azure DevOps config seems to not work as expected

[Dennisovan92]

Hello Community,

Would like to kindly ask for some help here with configuration of GitVersion.yaml config.
What my concern is that once I merge PR from develop to release my tag looks for example like this 1.3.0-release.1-98 and I do not expect to have these numbers in postfix.

1.3.0-develop.676 which is fine for me
1.3.0-release.1-98 which I would expect to be 1.3.0-release.1 and last number in postfix incrementing
and for master:
1.2.3-33 which should be 1.2.3 and patch number incrementing

Can anyone explain how to achieve this ?
If more details needed just let me know 👍🏼

Currently I have my config like this :

---
mode: ContinuousDelivery
branches:
  develop:
    tag: develop
    increment: Minor
  release:
    regex: release[-/](?<name>\d+\.\d+)
    tag: rc
    increment: Patch
    is-release-branch: true
    track-merge-target: false
  master:
    increment: Patch
    tag: ''
ignore:
  sha: []
merge-message-formats: {}

However my tags are named differently.

For develop branch:

{
  "Major": 1,
  "Minor": 3,
  "Patch": 0,
  "PreReleaseTag": "develop.676",
  "PreReleaseTagWithDash": "-develop.676",
  "PreReleaseLabel": "develop",
  "PreReleaseLabelWithDash": "-develop",
  "PreReleaseNumber": 676,
  "WeightedPreReleaseNumber": 676,
  "BuildMetaData": null,
  "BuildMetaDataPadded": "",
  "FullBuildMetaData": "Branch.develop.Sha.2eedcdfc906524ebcfde64d004e4c3570c595890",
  "MajorMinorPatch": "1.3.0",
  "SemVer": "1.3.0-develop.676",
  "LegacySemVer": "1.3.0-develop676",
  "LegacySemVerPadded": "1.3.0-develop0676",
  "AssemblySemVer": "1.3.0.0",
  "AssemblySemFileVer": "1.3.0.0",
  "FullSemVer": "1.3.0-develop.676",
  "InformationalVersion": "1.3.0-develop.676+Branch.develop.Sha.2eedcdfc906524ebcfde64d004e4c3570c595890",
  "BranchName": "develop",
  "EscapedBranchName": "develop",
  "Sha": "2eedcdfc906524ebcfde64d004e4c3570c595890",
  "ShortSha": "2eedcdf",
  "NuGetVersionV2": "1.3.0-develop0676",
  "NuGetVersion": "1.3.0-develop0676",
  "NuGetPreReleaseTagV2": "develop0676",
  "NuGetPreReleaseTag": "develop0676",
  "VersionSourceSha": "d15e673a9a8e9f823884ce53506c8ad3d6d00b71",
  "CommitsSinceVersionSource": 98,
  "CommitsSinceVersionSourcePadded": "0098",
  "UncommittedChanges": 0,
  "CommitDate": "2024-06-11"
}

For release branch:

{
  "Major": 1,
  "Minor": 3,
  "Patch": 0,
  "PreReleaseTag": "release.1",
  "PreReleaseTagWithDash": "-release.1",
  "PreReleaseLabel": "release",
  "PreReleaseLabelWithDash": "-release",
  "PreReleaseNumber": 1,
  "WeightedPreReleaseNumber": 1,
  "BuildMetaData": null,
  "BuildMetaDataPadded": "",
  "FullBuildMetaData": "Branch.release.Sha.c3691971a391e0c704f449b51830b4b754d9bc24",
  "MajorMinorPatch": "1.3.0",
  "SemVer": "1.3.0-release.1",
  "LegacySemVer": "1.3.0-release1",
  "LegacySemVerPadded": "1.3.0-release0001",
  "AssemblySemVer": "1.3.0.0",
  "AssemblySemFileVer": "1.3.0.0",
  "FullSemVer": "1.3.0-release.1",
  "InformationalVersion": "1.3.0-release.1+Branch.release.Sha.c3691971a391e0c704f449b51830b4b754d9bc24",
  "BranchName": "release",
  "EscapedBranchName": "release",
  "Sha": "c3691971a391e0c704f449b51830b4b754d9bc24",
  "ShortSha": "c369197",
  "NuGetVersionV2": "1.3.0-release0001",
  "NuGetVersion": "1.3.0-release0001",
  "NuGetPreReleaseTagV2": "release0001",
  "NuGetPreReleaseTag": "release0001",
  "VersionSourceSha": "c3691971a391e0c704f449b51830b4b754d9bc24",
  "CommitsSinceVersionSource": 0,
  "CommitsSinceVersionSourcePadded": "0000",
  "UncommittedChanges": 0,
  "CommitDate": "2024-06-11"`
  }

For master:

{
"Major": 1,
"Minor": 3,
"Patch": 0,
"PreReleaseTag": "27",
"PreReleaseTagWithDash": "-27",
"PreReleaseLabel": "",
"PreReleaseLabelWithDash": "-",
"PreReleaseNumber": 27,
"WeightedPreReleaseNumber": 55027,
"BuildMetaData": null,
"BuildMetaDataPadded": "",
"FullBuildMetaData": "Branch.master.Sha.82ffa9bcda8a90621e8e78bcf646535ad274e2ee",
"MajorMinorPatch": "1.3.0",
"SemVer": "1.3.0-27",
"LegacySemVer": "1.3.0-27",
"LegacySemVerPadded": "1.3.0-0027",
"AssemblySemVer": "1.3.0.0",
"AssemblySemFileVer": "1.3.0.0",
"FullSemVer": "1.3.0-27",
"InformationalVersion": "1.3.0-27+Branch.master.Sha.82ffa9bcda8a90621e8e78bcf646535ad274e2ee",
"BranchName": "master",
"EscapedBranchName": "master",
"Sha": "82ffa9bcda8a90621e8e78bcf646535ad274e2ee",
"ShortSha": "82ffa9b",
"NuGetVersionV2": "1.3.0-0027",
"NuGetVersion": "1.3.0-0027",
"NuGetPreReleaseTagV2": "0027",
"NuGetPreReleaseTag": "0027",
"VersionSourceSha": "82ffa9bcda8a90621e8e78bcf646535ad274e2ee",
"CommitsSinceVersionSource": 0,
"CommitsSinceVersionSourcePadded": "0000",
"UncommittedChanges": 0,
"CommitDate": "2024-06-03"
}

[Dennisovan92]

@HHobeck I saw that you were advising others on such configuration may I kindly ask you if possible to take a look what seems to be an issue with my configuration ?

[Dennisovan92]

Thank you very much for providing information about problems you are facing when using the documentation. If you not mind could you please create a PR for this and fix it? I'm going to help you in case you have not the knowledge about the description. This will something part of the code review.

Yes sure why not I can create PR, but I woud appreciate some guidence from your side if possible. Im not that familiar with this project.

[Dennisovan92]

Thank you guys, I was able to upgrade GitVersion used by POC pipeline. and now master branch is working as expected but others not really, also there is a problem that not all properties described in branch configuration under docs mentioned below are valid parameters, during dotnet-gitversion /showconfig I can see error messages saying that some of them are not found on type 'GitVersion.Configuration.BranchConfiguration'.https://github.com/GitTools/GitVersion/blob/main/docs/input/docs/reference/configuration.md

Please see the following comment. This will be fixed in 6.0.0-rc.2:

#4039 (reply in thread)

The problem with is-main-branch is not know to me. What do you mean?

is-main-branch is not recognized as a parameter. When It's defined anywhere in configuration I get same error. not found on type 'GitVersion.Configuration.BranchConfiguration'.https://github.com/GitTools/GitVersion/blob/main/docs/input/docs/reference/configuration.md

I would like to know if there will be som significant change in a project because I meed this for my clients production workflow in case there will be some change I would need to ajdust around 30 pipelines.

[HHobeck]

is-main-branch is not recognized as a parameter. When It's defined anywhere in configuration I get same error. not found on type 'GitVersion.Configuration.BranchConfiguration'.https://github.com/GitTools/GitVersion/blob/main/docs/input/docs/reference/configuration.md

Can you please provide the error message and the steps to reproduce. I don't see any reasons why this property would be not recognized. see

GitVersion/src/GitVersion.Configuration/BranchConfiguration.cs

Line 78 in 4886101

public bool? IsMainBranch { get; internal set; }

Which version are you using?

[Dennisovan92]

The error message on this I can see when using dotnet-gitversion /showconfig
I'm using 6.0.0-alpha.1+Branch.main.Sha.fc5b3ff045ea0e0f59c9bf27096af9094ca17f0e dotnet-gitversion on MacOS.

Now I tired to do dotnet-gitversion init and when this generated the configuration file I get exactly the same error as before but for other parameter which is source-branches. Is there any chance to reach you somewhere else than here in this thread ? If yes please write me on [email protected] thanks alot .

[Dennisovan92]

The error message on this I can see when using dotnet-gitversion /showconfig I'm using 6.0.0-alpha.1+Branch.main.Sha.fc5b3ff045ea0e0f59c9bf27096af9094ca17f0e dotnet-gitversion on MacOS.

Now I tired to do dotnet-gitversion init and when this generated the configuration file I get exactly the same error as before but for other parameter which is source-branches. Is there any chance to reach you somewhere else than here in this thread ? If yes please write me on [email protected] thanks alot .

Seems that the init mixed up old config with new configuration. so issue with source-branch is solved now.

[HHobeck]

For me it is very hard to understand your custom workflow. Normally it would be good to start with the GitFlow or GitHubFlow workflow (by defining the workflow property respectively) and change only minor configuration settings. Anyway you need to isolate your problems and put it in smaller parts.

If I see your configuration you are not defining your workflow from scratch but inheriting from the GitFlow workflow. This is because of backwards compatible reasons. Was this intended? If not you need to write: workflow: ''

If you take e.g. the following sequence diagram:
https://github.com/GitTools/GitVersion/blob/main/docs/input/docs/img/DocumentationSamplesForGitFlow_DevelopBranch.png

What would be your expectation and why?

Edit: The configuration base template for the GitFlow workflow is documented in the configuration.md or can be viewed as following:
https://github.com/GitTools/GitVersion/blob/main/docs/input/docs/workflows/GitFlow/v1.yml

[Dennisovan92]

Im even more confused now. What is the difference between GitFlow and workflow ? Based on a picture release branch is deleted in some point but we persist the release branch. I don't know how to explain this whole to you is there any chance we can have a quick meeting online ?

[Dennisovan92]

mode: ContinuousDelivery
branches:
  main:
    mode: ContinuousDeployment
    label: ''
    increment: Minor
    track-merge-target: false
    regex: ^master$|^main$
    pre-release-weight: 55000

  develop:
    mode: ContinuousDelivery
    label: develop
    increment: None
    track-merge-target: true
    regex: ^dev(elop)?$
    source-branches:
      - feature
      - release
      - main

  release:
    mode: ContinuousDelivery
    label: rc
    increment: Inherit
    regex: ^release[/-]
    source-branches:
      - develop
      - bugfix
    is-release-branch: true

  feature:
    mode: ContinuousDelivery
    label: feature-{BranchName}
    increment: None
    track-merge-target: false
    regex: ^feature/.*
    source-branches:
      - develop
    is-source-branch-for:
      - develop

  hotfix:
    mode: ContinuousDeployment
    label: hotfix-{BranchName}
    increment: Patch
    track-merge-target: true
    regex: ^hotfix/.*
    source-branches:
      - main
    is-source-branch-for:
      - main

  bugfix:
    mode: ContinuousDelivery
    label: bugfix-{BranchName}
    increment: Patch
    track-merge-target: true
    regex: ^bugfix/.*
    source-branches:
      - release
    is-source-branch-for:
      - release

  pull-request:
    mode: ContinuousDelivery
    increment: None
    label-number-pattern: '[/-](?<number>\d+)[/-]'
    regex: ^(pull|pull\-requests|pr)[/-]
    source-branches:
      - develop
      - main
      - release
      - feature
      - hotfix
    pre-release-weight: 30000
ignore:
  sha: []

This is how I have it at the moment. and to explain we have 3 branches develop release and master. we push features first in develop than we merge develop to release during codefreeze than if fix is needed we push it to release and at the end we merge release to master which is production branch in master we push only bugfix if needed.

this is what I expect to do it :

develop = 1.0.0-develop
feature/some-feature -- merge--to--develop --> 1.0.0-develop.1
feature/some-other-feature -- merge--to--develop --> 1.0.0develop.2
.... and so on ...

1.0.0develop.2 --merge--to--release --> 1.0.0release1
bugfix/some-bugfix --merge--to--release --> 1.0.0release1-1
bugfix/some-other-bugfix --merge--to--release --> 1.0.0release1-2

soft release/
1.0.0release1-2 --merge--to--develop --> 1.1.0 ???

1.0.0release1-2 --merge--to--master --> 1.1.0

master to develop
1.1.0 --merge--to--develop --> 1.1.0develop1

develop to release
1.1.0develop1 --merge--to--release --> 1.1.0release1

release to master
1.1.0release1 --merge--to--master --> 1.2.0

and in case I push hotfix to master than patch is incremented not major thats the expectation. Hopefully I explained

[HHobeck]

First of all please read the configuration.md and other documentation (sequence diagram examples?) and try to use the GitFlow or GitHubFlow workflow first before starting to write your own workflow.

In the documentation the following is written:

The following supported workflow configurations are available in GitVersion and can be referenced by the workflow property:

GitFlow (GitFlow/v1)
GitHubFlow (GitHubFlow/v1)
TrunkBased (TrunkBased/preview1)

and

workflow
The base template of the configuration to use. Possible values are GitFlow/v1 or GitHubFlow/v1. Defaults to GitFlow/v1 if not set. To create a configuration from scratch without using a base template, please specify an empty string.

My time is limited and if you like I can build a custom workflow together with you no problem. For that please engage me or other people who can help you. If you don't want this you need to isolate your problems to dedicated issues/questions (like I already mentioned).

Thank you for your understanding.

[Dennisovan92]

@HHobeck would you mind to share your email address and availability for a meeting ? to [email protected] ? So I can create a meeting and hopefully whole thing could be done in hour or so.