Directory.Build.props

<Project TreatAsLocalProperty="VersionPrefix">
  <!-- To extend/change the defaults, create a Directory.props alongside this file -->

  <PropertyGroup Label="CI" Condition="'$(CI)' == ''">
    <CI>false</CI>
    <!-- GH, CircleCI, GitLab and BitBucket already use CI -->
    <CI Condition="'$(TF_BUILD)' == 'true' or 
                   '$(TEAMCITY_VERSION)' != '' or 
                   '$(APPVEYOR)' != '' or 
                   '$(BuildRunner)' == 'MyGet' or 
                   '$(JENKINS_URL)' != '' or 
                   '$(TRAVIS)' == 'true' or 
                   '$(BUDDY)' == 'true'">true</CI>
  </PropertyGroup>

  <PropertyGroup>
    <!-- The Microsoft.Managed.Core.targets use this property to use deterministic source paths in CI builds -->
    <ContinuousIntegrationBuild>$(CI)</ContinuousIntegrationBuild>
  </PropertyGroup>

  <PropertyGroup Label="NuGet">
    <Authors>Daniel Cazzulino</Authors>
    <Company>Devlooped</Company>
    <Copyright>Copyright (C) Daniel Cazzulino and Contributors. All rights reserved.</Copyright>
    <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
    <PackageLicenseExpression>MIT</PackageLicenseExpression>

    <!-- Pick src-level readme+icon automatically -->
    <PackageIcon Condition="Exists('$(MSBuildThisFileDirectory)icon.png')">icon.png</PackageIcon>
    <PackageReadmeFile Condition="'$(PackReadme)' != 'false' and Exists('$(MSBuildThisFileDirectory)readme.md')">readme.md</PackageReadmeFile>
    <!-- Pick project-level readme+icon overrides automatically -->
    <PackageIcon Condition="Exists('$(MSBuildProjectDirectory)\icon.png')">icon.png</PackageIcon>
    <PackageReadmeFile Condition="'$(PackReadme)' != 'false' and Exists('$(MSBuildProjectDirectory)\readme.md')">readme.md</PackageReadmeFile>

    <PublishRepositoryUrl>true</PublishRepositoryUrl>
    <GenerateRepositoryUrlAttribute>true</GenerateRepositoryUrlAttribute>

    <PackageOutputPath Condition="'$(PackageOutputPath)' == ''">$([System.IO.Path]::GetFullPath('$(MSBuildThisFileDirectory)..\bin'))</PackageOutputPath>

    <!-- Use Directory.Packages.props if possible. NOTE: other MSBuild SDKs (i.e. NoTargets/Traversal) do not support central packages -->
    <ManagePackageVersionsCentrally Condition="Exists('$(MSBuildThisFileDirectory)Directory.Packages.props')">true</ManagePackageVersionsCentrally>
    <CentralPackageFloatingVersionsEnabled>true</CentralPackageFloatingVersionsEnabled>

    <!-- Ensure MSBuild tooling can access package artifacts always via PKG_[PackageId] -->
    <GeneratePathProperty>true</GeneratePathProperty>
    <!-- Avoid warnings for test projects when we run dotnet pack on the whole solution. -->
    <WarnOnPackingNonPackableProject>false</WarnOnPackingNonPackableProject>
    <!-- See https://learn.microsoft.com/en-us/nuget/consume-packages/package-references-in-project-files#prunepackagereference-specification -->
    <RestoreEnablePackagePruning>true</RestoreEnablePackagePruning>
  </PropertyGroup>

  <PropertyGroup Label="Build">
    <Configuration Condition="'$(Configuration)' == '' and $(CI)">Release</Configuration>
    <LangVersion>Latest</LangVersion>

    <!-- See https://docs.microsoft.com/en-us/dotnet/standard/assembly/reference-assemblies -->
    <ProduceReferenceAssembly>false</ProduceReferenceAssembly>
    <!-- Because they are small and super useful and supported everywhere -->
    <DebugType>embedded</DebugType>
    <DebugSymbols>true</DebugSymbols>
    <Nullable>enable</Nullable>
    <!-- See https://www.meziantou.net/csharp-compiler-strict-mode.htm -->
    <Features>strict</Features>
    
    <!-- Simplify namespaces by defaulting to the single root name -->
    <RootNamespace>$(MSBuildProjectName)</RootNamespace>
    <RootNamespaceDot>$(MSBuildProjectName.IndexOf('.'))</RootNamespaceDot>
    <RootNamespace Condition="'$(RootNamespaceDot)' != '-1'">$(MSBuildProjectName.Substring(0, $(RootNamespaceDot)))</RootNamespace>

    <!-- We typically don't want these files shown in the solution explorer -->
    <DefaultItemExcludes>$(DefaultItemExcludes);*.binlog;*.zip;*.rsp;*.items;**/TestResults/**/*.*</DefaultItemExcludes>

    <EnableSourceLink>true</EnableSourceLink>
    <EnableSourceControlManagerQueries>true</EnableSourceControlManagerQueries>
    <EmbedUntrackedSources>true</EmbedUntrackedSources>
    <UseSourceLink>true</UseSourceLink>

    <!-- Generate satellite assemblies using csc.exe to avoid some al.exe issues. See https://github.com/dotnet/msbuild/pull/2726 -->
    <GenerateSatelliteAssembliesForCore>true</GenerateSatelliteAssembliesForCore>

    <!-- See: https://www.cazzulino.com/project-dependencies-as-project-references.html -->
    <AddSyntheticProjectReferencesForSolutionDependencies>false</AddSyntheticProjectReferencesForSolutionDependencies>

    <!-- Don't warn for packages using semver 2.0 -->
    <NoWarn>NU5105;$(NoWarn)</NoWarn>
    <!-- Turn warnings into errors in CI or Release builds -->
    <WarningsAsErrors Condition="$(CI) or '$(Configuration)' == 'Release'">true</WarningsAsErrors>
    
    <!-- Preserve transitively copied content in VS: https://github.com/dotnet/msbuild/issues/1054#issuecomment-847959047 -->
    <MSBuildCopyContentTransitively>true</MSBuildCopyContentTransitively>
    
    <!-- Global tools should run on whatever latest runtime is installed. See https://docs.microsoft.com/en-us/dotnet/core/versions/selection#framework-dependent-apps-roll-forward -->
    <RollForward>LatestMinor</RollForward>
  </PropertyGroup>

  <PropertyGroup Label="StrongName" Condition="Exists('$(MSBuildThisFileDirectory)kzu.snk')">
    <!-- We use a single oss signing key for consumers that need strong-named assemblies -->
    <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)kzu.snk</AssemblyOriginatorKeyFile>
    <!-- These properties make it easier to add internals visible to other projects, even when signing is involved.
         For example, you can simply add: 
          <InternalsVisibleTo Include="MyProject.UnitTests" />

         and the key will be appended automatically.
    -->
    <PublicKey>002400000480000094000000060200000024000052534131000400000100010051155fd0ee280be78d81cc979423f1129ec5dd28edce9cd94fd679890639cad54c121ebdb606f8659659cd313d3b3db7fa41e2271158dd602bb0039a142717117fa1f63d93a2d288a1c2f920ec05c4858d344a45d48ebd31c1368ab783596b382b611d8c92f9c1b3d338296aa21b12f3bc9f34de87756100c172c52a24bad2db</PublicKey>
    <PublicKeyToken>00352124762f2aa5</PublicKeyToken>
    <SignAssembly>true</SignAssembly>
  </PropertyGroup>

  <PropertyGroup Label="Version">
    <!-- Versioning: when building locally, it's always 42.42.42. 
         This makes it always bigger than any public package version, and 
         consistent and fixed for dogfooding. 
         NuGetizer nukes the package cache on build, making this straightforward too.
         CI (non-release) builds pass in a VersionSuffix property to append a label 
         after the fixed prefix. This allows dogfooding a branch build.
         The suffix is sanitized and optionally turned into 
    -->
    <VersionPrefix Condition="$(VersionPrefix) == ''">42.42.42</VersionPrefix>
  </PropertyGroup>

  <PropertyGroup Label="Version" Condition="$(VersionLabel) != ''">
    <_VersionLabel>$(VersionLabel.Replace('refs/heads/', ''))</_VersionLabel>
    <_VersionLabel>$(_VersionLabel.Replace('refs/tags/v', ''))</_VersionLabel>

    <!-- For PRs, we just need a fixed package version numbered after the PR # itself, so remove the commits # at the end -->
    <_VersionLabel Condition="$(_VersionLabel.Contains('refs/pull/'))">$(VersionLabel.TrimEnd('.0123456789'))</_VersionLabel>
    <!-- Next replace the prefix for simply 'pr', so we end up with 'pr99/merge' by default -->
    <_VersionLabel>$(_VersionLabel.Replace('refs/pull/', 'pr'))</_VersionLabel>
    <!-- Remove the /merge now, if present -->
    <_VersionLabel>$(_VersionLabel.Replace('/merge', ''))</_VersionLabel>
    <!-- Finally sanitize the branch with dashes, so we can build path-separated branches, like rel/v1.0.0 or feature/foo -->
    <_VersionLabel>$(_VersionLabel.Replace('/', '-'))</_VersionLabel>
    <!-- And underscores which are also invalid labels, so we can use branches like dev/feature_foo -->
    <_VersionLabel>$(_VersionLabel.Replace('_', '-'))</_VersionLabel>

    <!-- Set sanitized version to the actual version suffix used in build/pack -->
    <VersionSuffix Condition="!$(VersionLabel.Contains('refs/tags/'))">$(_VersionLabel)</VersionSuffix>
    <!-- Special case for tags, the label is actually the version. Backs compat since passed-in value overrides MSBuild-set one -->
    <Version Condition="$(VersionLabel.Contains('refs/tags/'))">$(_VersionLabel)</Version>

    <!-- In order for latest from main/master to always be greatest when using -prerelease switch on install/run, 
         we change the scheme as follows:
         - main/master remain as today: VersionPrefix: 42.42.${{ github.run_number }}  (from yaml)
         - others: VersionPrefix: 42.42.0-[label].${{ github.run_number }}
    -->
    <IsMaster Condition="$(VersionLabel.Contains('refs/heads/main')) or $(VersionLabel.Contains('refs/heads/master'))">true</IsMaster>
    <VersionPrefix Condition="'$(IsMaster)' != 'true'">42.42.0</VersionPrefix>
    <VersionSuffix Condition="'$(IsMaster)' != 'true'">$(VersionSuffix).$(GITHUB_RUN_NUMBER)</VersionSuffix>
  </PropertyGroup>

  <ItemGroup Label="ThisAssembly.Project">
    <ProjectProperty Include="CI" />
  
    <ProjectProperty Include="Version" />
    <ProjectProperty Include="VersionPrefix" />
    <ProjectProperty Include="VersionSuffix" />

    <ProjectProperty Include="PublicKey" />
    <ProjectProperty Include="PublicKeyToken" />
  </ItemGroup>

  <ItemGroup Label="Throw">
    <Using Include="System.ArgumentException" Static="true" />
    <Using Include="System.ArgumentOutOfRangeException" Static="true" />
    <Using Include="System.ArgumentNullException" Static="true" />
  </ItemGroup>

  <ItemGroup Label="OSMF" Condition="Exists('$(MSBuildThisFileDirectory)..\osmfeula.txt')">
    <None Include="$(MSBuildThisFileDirectory)..\osmfeula.txt" Link="osmfeula.txt" PackagePath="OSMFEULA.txt" />
  </ItemGroup>

  <Import Project="Directory.props" Condition="Exists('Directory.props')"/>
  <Import Project="Directory.props.user" Condition="Exists('Directory.props.user')" />

  <!-- If the imported props changed ManagePackageVersionsCentrally, we need to replicate 
       the Version defaults from Microsoft.NET.DefaultAssemblyInfo.targets since it's too 
       early here and Directory.Packages.props will be imported right after this time, 
       meaning dependencies that expect to use the currently building Version would not 
       get the expected value.
   -->
  <PropertyGroup Condition="'$(ManagePackageVersionsCentrally)' == 'true' and '$(Version)' == ''">
    <VersionPrefix Condition=" '$(VersionPrefix)' == '' ">1.0.0</VersionPrefix>
    <Version Condition=" '$(VersionSuffix)' != '' ">$(VersionPrefix)-$(VersionSuffix)</Version>
    <Version Condition=" '$(Version)' == '' ">$(VersionPrefix)</Version>
  </PropertyGroup>

  <!-- Implemented by SDK in .targets, guaranteeing it's overwritten. Added here since we add a DependsOnTargets to it. 
       Covers backwards compatiblity with non-SDK projects. -->
  <Target Name="InitializeSourceControlInformation" />
</Project>