NetChris.Build.MSBuild 1.1.444315244

NetChris.Build.MSBuild

Provides:

• Consistent versioning of assemblies and packages

Use

In your project's *.csproj file:

• Set <VersionPrefix /> to the {Major}.{Minor} version of your project
• Add the reference: dotnet add package NetChris.Build.MSBuild
• Alternately, directly add the PackageReference in your project, using the appropriate major and minor versions:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard1.1</TargetFramework>
    <AssemblyName>NetChris.MyAssembly</AssemblyName>
    <RootNamespace>NetChris.Standard.MyAssembly</RootNamespace>

    <GenerateDocumentationFile>true</GenerateDocumentationFile>
    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
    
    <VersionPrefix>0.2</VersionPrefix>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="NetChris.Build.MSBuild" Version="0.3.*">
      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
      <PrivateAssets>all</PrivateAssets>
    </PackageReference>
  </ItemGroup>
</Project>

This relies on this blurb from "Include MSBuild props and targets in a package":

You might want to add custom build targets or properties in projects that consume your package, such as running a custom tool or process during build. You do this by placing files in the form <package_id>.targets or <package_id>.props [...] within the \build folder of the project.

Variables during build

There are a few properties you can set to vary the versioning. These values can also be supplied through environment variables. They are primarily of use in CI/CD scenarios.

References

• Customize your build
• How to: Extend the Visual Studio build process
• Version vs VersionSuffix vs PackageVersion: What do they all mean? (Andrew Lock)
• Create a NuGet package using the dotnet CLI
• Create a package using the nuget.exe CLI / Include MSBuild props and targets in a package
• nuspec reference
• Publish a NuGet package by using CI/CD
• SemVer