MSBuild task fails in AzDO pipeline docker build, but not locally

[sanghel-orbyta]

Please help me understand a problem I'm having.

I have a solution with multiple projects:

• project 1 - webappruntime
• project 2 - shared sdk1
• project 3 - shared sdk2 that references GitVersion

In project 3 GitVersion.MsBuild is used like so:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net8.0</TargetFramework>
  </PropertyGroup>

  <PropertyGroup>
    <WriteVersionInfoToBuildLog>true</WriteVersionInfoToBuildLog>
    <UpdateAssemblyInfo>true</UpdateAssemblyInfo>
    <GenerateGitVersionInformation>true</GenerateGitVersionInformation>
    <GetVersion>true</GetVersion>
    <GenerateGitVersionWixDefines>false</GenerateGitVersionWixDefines>
    <UpdateVersionProperties>true</UpdateVersionProperties>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="GitVersion.MsBuild" Version="5.12.0">
      <PrivateAssets>All</PrivateAssets>
    </PackageReference>
  </ItemGroup>

</Project>

There is no GitVersion.yml defined.

Also, this project exposes a helper that allows exposing computed GitVersion variables at runtime:

public static class GitVersionHelper
{
    public static string GetGitVersionVariable(string fieldName)
    {
        var assembly = Assembly.GetExecutingAssembly();
        var gitVersionInformationType = assembly.GetType("GitVersionInformation");
        var versionField = gitVersionInformationType?.GetField(fieldName);
        return (string?)versionField?.GetValue(null) ?? string.Empty;
    }
}

Building and running locally works ok (I'm having issues with version 6.0.0 as signaled in #4116, but that is another story).

For this project I have a Dockerfile:

FROM mcr.microsoft.com/dotnet/aspnet:8.0-jammy-chiseled AS base
USER app
WORKDIR /app
EXPOSE 8080

FROM mcr.microsoft.com/dotnet/sdk:8.0-jammy AS build

ARG RUNTIME_IDENTIFIER=linux-x64

WORKDIR /src

COPY ["NuGet.Config", "."]
COPY ["common.props", "."]
COPY ["src/Project1/Project1.csproj", "src/Project1/"]
COPY ["src/Project2/Project2.csproj", "src/Project2/"]
COPY ["src/Project3/Project3.csproj", "src/Project3/"]
RUN dotnet restore "./src/Project1/Project1.csproj" /p:RuntimeIdentifier=$RUNTIME_IDENTIFIER

ARG BUILD_CONFIGURATION=Release
COPY . . # <--------------------------------------------- THIS ALSO COPIES the .git folder
WORKDIR "/src/src/Project1"
RUN dotnet build "./Project1.csproj" -c $BUILD_CONFIGURATION --no-restore -o /app/build /p:RuntimeIdentifier=$RUNTIME_IDENTIFIER

FROM build AS publish
RUN dotnet publish "./Project1.csproj" -c $BUILD_CONFIGURATION --no-restore -o /app/publish /p:UseAppHost=false /p:RuntimeIdentifier=$RUNTIME_IDENTIFIER

FROM base AS final
WORKDIR /app

COPY --from=publish /app/publish .
ENTRYPOINT ["dotnet", "Project1.dll"]

Note that COPY . . also copies the .git folder as it is commented out in the .dockerignore file

Building the image locally works.

However building the image in a AzureDevOps pipeline, triggered for every commit on a feature/something branch, fails.

The pipeline yaml, is:

resources:
  repositories:
  - repository: self

variables:
- name: sourceRepoName
  value: myreponame
- name: baseDockerfilesPath
  value: $(Build.SourcesDirectory)/src
- name: ACRRepoName
  value: myproject

stages:
- stage: BuildAndPushImagesStage
  displayName: 'Build and push "${{variables.sourceRepoName}}" container images stage'
  jobs:
  - job: BuildAndPushImagesJob
    displayName: 'Build and push "${{variables.sourceRepoName}}" container images stage job'
    pool:
      vmImage: "ubuntu-latest"
    steps:
    - checkout: self
      displayName: 'Checkout "$(sourceRepoName)" repo'
      fetchDepth: 0
      fetchTags : true
      clean: true

    - task: Docker@2
      displayName: 'Build container image'
      inputs:
          command: build
          repository: $(ACRRepoName)
          buildContext: '$(Build.SourcesDirectory)'
          dockerfile: '$(baseDockerfilesPath)/Project1/Dockerfile'
          containerRegistry: $(dockerRegistryServiceConnection) # from included variable group
          tags: $(dockerTag)

The pipeline fails at the docker build step, at the build stage with:

....
##[error]#22 [build 14/14] RUN dotnet build "./Project1.csproj" -c Release --no-restore -o /app/build /p:RuntimeIdentifier=linux-x64
   INFO [07/25/24 16:58:33:56] Applicable build agent found: 'LocalBuild'.
   INFO [07/25/24 16:58:33:61] Working directory: /src/src/Project3
   INFO [07/25/24 16:58:33:63] Project root is: /src/
   INFO [07/25/24 16:58:33:63] DotGit directory is: /src/.git
   INFO [07/25/24 16:58:33:63] Branch from build environment: 
   INFO [07/25/24 16:58:33:66] Begin: Loading version variables from disk cache
     INFO [07/25/24 16:58:33:66] Cache file /src/.git/gitversion_cache/FF209CED7104C2BF3838D222229A43D4C906916D.yml not found.
     INFO [07/25/24 16:58:33:66] End: Loading version variables from disk cache (Took: 0.67ms)
     INFO [07/25/24 16:58:33:66] Using latest commit on specified branch
     INFO [07/25/24 16:58:33:67] Begin: Getting branches containing the commit 'cd5fd18'.
       INFO [07/25/24 16:58:33:67] Trying to find direct branches.
       INFO [07/25/24 16:58:33:67] No direct branches found, searching through all branches.
       INFO [07/25/24 16:58:33:67] Searching for commits reachable from 'origin/develop'.
       INFO [07/25/24 16:58:33:68] The branch 'origin/develop' has no matching commits.
       INFO [07/25/24 16:58:33:68] Searching for commits reachable from 'origin/feature/18664'.
       INFO [07/25/24 16:58:33:68] The branch 'origin/feature/18664' has no matching commits.
       INFO [07/25/24 16:58:33:68] Searching for commits reachable from 'origin/feature/20372'.
       INFO [07/25/24 16:58:33:68] Searching for commits reachable from 'origin/feature/backoffice-fe'.
       INFO [07/25/24 16:58:33:68] The branch 'origin/feature/backoffice-fe' has no matching commits.
       INFO [07/25/24 16:58:33:68] Searching for commits reachable from 'origin/feature/docker-image'.
       INFO [07/25/24 16:58:33:69] The branch 'origin/feature/docker-image' has no matching commits.
       INFO [07/25/24 16:58:33:69] Searching for commits reachable from 'origin/main'.
       INFO [07/25/24 16:58:33:69] The branch 'origin/main' has no matching commits.
     INFO [07/25/24 16:58:33:69] End: Getting branches containing the commit 'cd5fd18'. (Took: 12.40ms)
     INFO [07/25/24 16:58:33:76] Running against branch: origin/feature/20372 (cd5fd18 initial setup)
     INFO [07/25/24 16:58:33:76] Current commit is tagged with version 0.1.0-test, version calculation is for metadata only.
     INFO [07/25/24 16:58:33:76] 0 commits found between cd5fd18 initial setup and cd5fd18 initial setup
     INFO [07/25/24 16:58:33:76] Begin: Calculating base versions
       INFO [07/25/24 16:58:33:77] Begin: Attempting to inherit branch configuration from parent branch
         INFO [07/25/24 16:58:33:77] Begin: Finding branch source of 'origin/feature/20372'
         INFO [07/25/24 16:58:33:78] End: Finding branch source of 'origin/feature/20372' (Took: 6.53ms)
         INFO [07/25/24 16:58:33:78] Begin: Getting branches containing the commit 'cd5fd18'.
           INFO [07/25/24 16:58:33:78] Trying to find direct branches.
           INFO [07/25/24 16:58:33:78] No direct branches found, searching through all branches.
           INFO [07/25/24 16:58:33:78] Searching for commits reachable from 'origin/develop'.
           INFO [07/25/24 16:58:33:78] The branch 'origin/develop' has no matching commits.
           INFO [07/25/24 16:58:33:78] Searching for commits reachable from 'origin/main'.
           INFO [07/25/24 16:58:33:78] The branch 'origin/main' has no matching commits.
         INFO [07/25/24 16:58:33:78] End: Getting branches containing the commit 'cd5fd18'. (Took: 1.34ms)
         INFO [07/25/24 16:58:33:78] Found possible parent branches: 
       INFO [07/25/24 16:58:33:78] End: Attempting to inherit branch configuration from parent branch (Took: 13.84ms)
     INFO [07/25/24 16:58:33:78] End: Calculating base versions (Took: 20.79ms)
     ERROR [07/25/24 16:58:33:79] An unexpected error occurred:
   System.InvalidOperationException: Gitversion could not determine which branch to treat as the development branch (default is 'develop') nor release-able branch (default is 'main' or 'master'), either locally or remotely. Ensure the local clone and checkout match the requirements or considering using 'GitVersion Dynamic Repositories'
      at GitVersion.Configuration.BranchConfigurationCalculator.InheritBranchConfiguration(Int32 recursions, IBranch targetBranch, BranchConfig branchConfiguration, ICommit currentCommit, Config configuration, IList`1 excludedInheritBranches) in D:\a\GitVersion\GitVersion\src\GitVersion.Core\Configuration\BranchConfigurationCalculator.cs:line 150
      at GitVersion.Configuration.BranchConfigurationCalculator.GetBranchConfigurationInternal(Int32 recursions, IBranch targetBranch, ICommit currentCommit, Config configuration, IList`1 excludedInheritBranches) in D:\a\GitVersion\GitVersion\src\GitVersion.Core\Configuration\BranchConfigurationCalculator.cs:line 54
      at GitVersion.Configuration.BranchConfigurationCalculator.GetBranchConfiguration(IBranch targetBranch, ICommit currentCommit, Config configuration, IList`1 excludedInheritBranches) in D:\a\GitVersion\GitVersion\src\GitVersion.Core\Configuration\BranchConfigurationCalculator.cs:line 28
      at GitVersion.VersionCalculation.BaseVersionCalculator.GetBaseVersion() in D:\a\GitVersion\GitVersion\src\GitVersion.Core\VersionCalculation\BaseVersionCalculator.cs:line 37
      at GitVersion.VersionCalculation.NextVersionCalculator.FindVersion() in D:\a\GitVersion\GitVersion\src\GitVersion.Core\VersionCalculation\NextVersionCalculator.cs:line 56
      at GitVersion.GitVersionCalculateTool.CalculateVersionVariables() in D:\a\GitVersion\GitVersion\src\GitVersion.Core\Core\GitVersionCalculateTool.cs:line 52
      at GitVersion.GitVersionExecutor.RunGitVersionTool(GitVersionOptions gitVersionOptions) in D:\a\GitVersion\GitVersion\src\GitVersion.App\GitVersionExecutor.cs:line 66
     INFO [07/25/24 16:58:33:79] Attempting to show the current git graph (please include in issue): 
     INFO [07/25/24 16:58:33:79] Showing max of 100 commits
     INFO [07/25/24 16:58:33:84] * cd5fd18 41 minutes ago  (HEAD, tag: 0.1.0-test, origin/feature/20372)
   | * 92b1f61 5 hours ago  (origin/feature/backoffice-fe)
   | * fac2302 5 hours ago 
   | *   bd91998 29 hours ago 
   | |\  
   | |/  
   |/|   
   | *   42ee48e 30 hours ago 
   | |\  
   | * \   350787d 33 hours ago 
   | |\ \  
   | * | | f2b3f37 2 days ago 
   | * | | e52198a 2 days ago 
   | * | | 3d6efda 2 days ago 
   | * | | 55bcfb1 3 days ago 
   | * | | 8c4f0bc 6 days ago 
   | * | |   11e4fb4 7 days ago 
   | |\ \ \  
   | * | | | 3f2f117 8 days ago 
   | * | | | 95a6ff7 9 days ago 
   | * | | |   b088ff4 9 days ago 
   | |\ \ \ \  
   | * \ \ \ \   0a48c76 10 days ago 
   | |\ \ \ \ \  
   | * | | | | | acd95ab 10 days ago 
   | * | | | | | b89bb93 13 days ago 
   | * | | | | |   fc25254 13 days ago 
   | |\ \ \ \ \ \  
   | * | | | | | | d38e63c 13 days ago 
   | * | | | | | | 780eb4f 13 days ago 
   | * | | | | | | 4bf80ab 13 days ago 
   | * | | | | | | 26ec12d 2 weeks ago 
   | * | | | | | | e198b7e 2 weeks ago 
   | | | | | | | | * 99ae63b 6 hours ago  (origin/develop)
   | |_|_|_|_|_|_|/  
   |/| | | | | | |   
   * | | | | | | | 5bdf477 29 hours ago 
   | |_|_|_|_|_|/  
   |/| | | | | |   
   * | | | | | | bbf7fa9 31 hours ago 
   | |_|_|_|_|/  
   |/| | | | |   
   * | | | | | 83332eb 2 days ago 
   * | | | | | 410a77a 3 days ago 
   | |_|_|_|/  
   |/| | | |   
   * | | | | dd58842 7 days ago 
   | |_|_|/  
   |/| | |   
   | | | | * 87b2f35 8 days ago  (origin/feature/docker-image)
   | |_|_|/  
   |/| | |   
   * | | | 5aa5c63 9 days ago 
   | | | | *   0a7edee 10 days ago  (origin/feature/18664)
   | | | | |\  
   | |_|_|_|/  
   |/| | | |   
   * | | | | 6552630 10 days ago 
   | |_|/ /  
   |/| | |   
   | | | *   0426ffa 10 days ago 
   | | | |\  
   | |_|_|/  
   |/| | |   
   * | | | c12e677 10 days ago 
   | |/ /  
   |/| |   
   | | * 722c8e1 13 days ago 
   | | *   e9cb6be 13 days ago 
   | | |\  
   | |_|/  
   |/| |   
   * | | e99c264 2 weeks ago 
   |/ /  
   * | c529dc3 2 weeks ago 
   * | 0d52873 2 weeks ago 
   * | 8927622 2 weeks ago 
   | *   f454eb0 3 weeks ago 
 --- other graph omitted, main is still at first commit in repo

I don't understand why the MSbuild task fails. given that:

• my repo uses default branch names: main, develop, and feature/something
• the checkout step in the pipeline does a complete fetch, so it sees all commit and tags
• the .git folder is copied in the build container, and it is seen by gitversion.

I've also tried tagging (and pushing the tag) the commit from which I'm trigger the pipeline, but the error remains.

Also, I don't understand why the same identical Dockerfile is correctly built locally with docker build, but fails in the pipeline.

Maybe I'm missing something in the .git folder maybe, but I'm not sure what.

Are there any additional props / argument I could supply via the MSBuild props in the csproj file, that could help me understand the issue?

As documented in Extra Properties here, and in CLI Arguments here, I've tried adding

<PropertyGroup>
    ...  
    <GitVersion_CommandLineArguments>/showconfig /verbosity Verbose</GitVersion_CommandLineArguments>
</PropertyGroup>

but it didn't yield any difference in the output

I know about using the GitTools bundle of AzDO tasks directly in a pipeline, but I need the MSBuild to run during image building, because I need the GitVersionHelper to supply computed variables at runtime, not only at build time.

@arturcic and anyone else, any hints are welcome., I'm stumped.