Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 3.07 KB

readme.md

File metadata and controls

51 lines (31 loc) · 3.07 KB
Raw

SemanticVersioning.MSBuild

Downloads
Build Status

Introduction

This is a project for injecting Semantic Versioning to binaries via MSBuild at compile time. It does not rely on PowerShell, MSBuild Community Tasks or any other package dependency.

Currently this code works for

  • Visual Studio 2015+ projects (including the newer SDK project format)
  • C# .Net Standard Projects 1.4+

Quick Start

On your Build Server: set the following MSBuild properties:

  • $SemanticVersion = the Major.Minor.Patch version i.e. 1.0.0, 5.2.0 or 1.1.7
  • $Tag = the arbitary tag of a pre-release i.e. -beta1, -RC5 or -Build2
  • $BuildLabel = A build label as metadata (in the SemVer 2.0 format of +#### or +20181102.02)
  • GenerateAssemblyInfo depending on your build host you may need to manually set this to False.

If you want to run this directly from MSBuild you can use the following command line

msbuild.exe /t:Build /p:SemanticVersion=1.0.0;Tag=-beta1;GenerateAssemblyInfo=False <project filename>.csproj

The package by default works on the convention that Assembly attributes are in a AssemblyInfo file this can be overridden). It will make no changes to your source tree, all modifications are made at compile time.

This project currently supports Semantic Versioning for C# via MSBuild. Under request I might extend this to support both VB, F# and Native C++ projects (via resource manifests).

How it works.

By default the package will make no changes to your source tree. When building it fires on before-CoreCompile to modify a clone of file with the name AssemblyInfo excluding the extension (you can however inject alternative file names via $VersionFileName).

Typically for local builds in Visual Studio you wouldn't bother with Semantic Versioning as the changes are too rapid so you'll end up with 0.0.0 versioning. However by adding the appropriate properties to your CsProj file or via MSBuild Parameters you can achieve this locally.

This package's main use case is in Builds where you can clearly inject the Semantic Version via the following parameters:

  • $SemanticVersion = D.D.D, the Major Minor and Patch as integer digits separated by periods. e.g. 1.0.0 or 5.2.3
  • $Tag = -AADD+, A tag consisting of a Dash followed by any an arbitarty alphanumeric. e.g. -Beta12, -Build1 or -RC5
  • $VersionFileName = ABC123, an alphanumeric filename (excl. path and extension) where AssemblyAttributes are located i.e. CommonVersionInfo
  • $BuildLabel = an alphanumeric label (that may include dots but not other non-alphanumeric characters)

What Assembly Attributes are injected at Compile time?

The package will update your Assembly

  • AssemblyVersion => the Numeric portion of the version
  • AssemblyFileVersion => the Numeric portion of the version
  • AssemblyInformationalVersion => the Numeric portion of the version, the Tag and the BuildLabel Version