Jaahas.Cake.Extensions

Jaahas.Cake.Extensions is a recipe package for Cake, used to provide a common way of versioning and running builds using Cake.

Dependencies

Jaahas.Cake.Extensions assumes that you are using Cake v4.0.0 or later.

Getting Started

In the folder where your .NET solution file resides, create a version.json file that is structured as follows:

{
  "Major": 1,
  "Minor": 0,
  "Patch": 0,
  "PreRelease": ""
}

Update your build.cake file as follows:

const string DefaultSolutionFile = "./MySolution.sln";
const string VersionFile = "./version.json";

#load nuget:?package=Jaahas.Cake.Extensions&version=2.0.0

// Bootstrap build context and tasks.
Bootstrap(DefaultSolutionFile, VersionFile);

// Run the specified target.
Run();

Command Line Arguments

The following command line arguments are supported by the recipe:

Argument	Description	Default Value	Allowed Values
--branch=<FRIENDLY BRANCH NAME>	The friendly name of the source control branch that is being built. Ignored for Git repositories.
--project=<PROJECT OR SOLUTION>	The MSBuild project or solution to build.	DefaultSolutionFile constant in build.cake file
--target=<TARGET>	The Cake target to run.	Test	Clean, Restore, Build, Test, Pack, BillOfMaterials
--configuration=<CONFIGURATION>	The MSBuild configuration to use.	Debug; Release when the Pack target is specified	Any configuration defined in the MSBuild solution
--clean	Specifies that this is a rebuild rather than an incremental build. All artifact, bin, and test output folders will be cleaned prior to running the specified target.
--no-tests	Specifies that unit tests should be skipped, even if a target that depends on the Test target is specified.
--ci	Forces continuous integration build mode. Not required if the build is being run by a supported continuous integration build system.
--sign-output	Tells MSBuild that signing is required by setting the 'SignOutput' build property to 'True'. The signing implementation must be supplied by MSBuild.
--build-counter=<COUNTER>	The build counter. This is used when generating version numbers for the build.	-1
--build-metadata=<METADATA>	Additional build metadata that will be included in the information version number generated for compiled assemblies.
--property=<PROPERTY>	Specifies an additional property to pass to MSBuild during Build and Pack targets. The value must be specified using a <NAME>=<VALUE> format e.g. --property="NoWarn=CS1591". This argument can be specified multiple times.
--github-username=<USERNAME>	Specifies the GitHub username to use when making authenticated API calls to GitHub while running the BillOfMaterials task. You must specify the --github-token argument as well when specifying this argument.
--github-token=<PERSONAL ACCESS TOKEN>	Specifies the GitHub personal access token to use when making authenticated API calls to GitHub while running the BillOfMaterials task. You must specify the --github-username argument as well when specifying this argument.

Version Numbers

The version numbers generated by the build utilities are determined by the version.json file, the build counter, the build metadata, and the branch names. The version numbers use the following format:

Version	Format	Conditions
Assembly Version	MAJOR.MINOR.0.0
File Version	MAJOR.MINOR.PATCH.BUILD	Build counter >= 0
	MAJOR.MINOR.PATCH.0	Build counter < 0
Informational Version	MAJOR.MINOR.PATCH[-SUFFIX].[BUILD]+BRANCH[.METADATA]
Package Version	MAJOR.MINOR.PATCH[-SUFFIX].[BUILD]	Build counter >= 0
	MAJOR.MINOR.PATCH[-SUFFIX]	Build counter < 0
Build Number	MAJOR.MINOR.PATCH[-SUFFIX].[BUILD]+BRANCH	Build counter >= 0
	MAJOR.MINOR.PATCH[-SUFFIX]+BRANCH	Build counter < 0

Build System Integration

The build utilities automatically set the build number and and version numbers in the following build systems:

• TeamCity