Add tests for GitLab CI to ignore branch name for tags

[Bi0T1N]

Description

This PR adds the missing tests for PR #4187. That PR needs to be merged first since without the changes you'll see two errors:

NUnit Adapter 4.6.0.0: Test execution complete
  GitVersion.BuildAgents.Tests test net9.0 failed with 2 error(s) (1.0s)
    /workspaces/GitVersion/src/GitVersion.BuildAgents.Tests/Agents/GitLabCiTests.cs(74): error TESTERROR: 
      GetCurrentBranchShouldHandleTags("v1.0.0","v1.0.0",null) (31ms): Error Message: Shouldly.ShouldAssertException : result
          should be null but was
      "v1.0.0"
      Stack Trace:
         at GitVersion.Agents.Tests.GitLabCiTests.GetCurrentBranchShouldHandleTags(String branchName, String commitTag, String expectedResult) in /workspaces/GitVersion/src/GitVersion.BuildAgents.Tests/Agents/GitLabCiTests.cs:line 74
         at InvokeStub_GitLabCiTests.GetCurrentBranchShouldHandleTags(Object, Span`1)
         at System.Reflection.MethodBaseInvoker.InvokeWithFewArgs(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture)
    /workspaces/GitVersion/src/GitVersion.BuildAgents.Tests/Agents/GitLabCiTests.cs(74): error TESTERROR: 
      GetCurrentBranchShouldHandleTags("v1.2.1","v1.2.1",null) (1ms): Error Message: Shouldly.ShouldAssertException : result
          should be null but was
      "v1.2.1"
      Stack Trace:
         at GitVersion.Agents.Tests.GitLabCiTests.GetCurrentBranchShouldHandleTags(String branchName, String commitTag, String expectedResult) in /workspaces/GitVersion/src/GitVersion.BuildAgents.Tests/Agents/GitLabCiTests.cs:line 74
         at InvokeStub_GitLabCiTests.GetCurrentBranchShouldHandleTags(Object, Span`1)
         at System.Reflection.MethodBaseInvoker.InvokeWithFewArgs(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture)

Test summary: total: 90, failed: 2, succeeded: 88, skipped: 0, duration: 1.0s
Build failed with 2 error(s) in 3.2s

Related Issue

#4186

Motivation and Context

This pull request should help to get PR #4187 merged! With the changes from @AlphaYankee all tests succeed.

How Has This Been Tested?

To verify the behavior of the GitLab CI I created a test project that can be found here with all the relevant CI_* variables in the job log output.

This demonstrates how the tagging works in GitLab (CI_COMMIT_TAG available only in pipelines for tags):

• From commit Add .gitlab-ci.yml file to main branch (notice that CI_COMMIT_TAG isn't set)

CI_COMMIT_REF_NAME=main

• From tagging v1.0.0

CI_COMMIT_REF_NAME=v1.0.0
CI_COMMIT_TAG=v1.0.0

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

[arturcic]

@Bi0T1N can you actually push these changes to that PR instead?

[Bi0T1N]

How would I do that? I guess I'd need write permissions in the fork from AlphaYankee.

[arturcic]

it really depends if he put any branch restrictions on his fork, you just add his fork as another origin and push to his branch.

Another option would be instead of pushing to his branch (if there are set restrictions) you can integrate his changes into your PR (your rebase your branch on top of his), so his commits are first added and yours are on top of his changes, this way you keep his original work and yours

[Bi0T1N]

I added the changes from AlphaYankee to my branch by a patch file in the proper way.

[mergify]

Thank you @Bi0T1N for your contribution!