Generating AssemblyInfo files

INFO

This documentation is for FAKE version 5.0 or later. The old documentation can be found here

In this article the AssemblyInfo task is used in order to set specific version information to .NET assemblies.

If you succeeded with the Getting Started tutorial, then you just have to modify your BuildApp target to the following:

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 
13: 
14: 
15: 
16: 
17: 
18: 
19: 
20: 
21: 
22: 
23: 
24: 
25: 
26: 
27: 

#r "paket:
nuget Fake.DotNet.AssemblyInfoFile
nuget Fake.DotNet.MSBuild
nuget Fake.Core.Target //"
open Fake.Core
open Fake.DotNet

Target.create "BuildApp" (fun _ ->
    AssemblyInfoFile.createCSharp "./src/app/Calculator/Properties/AssemblyInfo.cs"
        [   AssemblyInfo.Title "Calculator Command line tool"
            AssemblyInfo.Description "Sample project for FAKE - F# MAKE"
            AssemblyInfo.Guid "A539B42C-CB9F-4a23-8E57-AF4E7CEE5BAA"
            AssemblyInfo.Product "Calculator"
            AssemblyInfo.Version version
            AssemblyInfo.FileVersion version]

    AssemblyInfoFile.createFSharp "./src/app/CalculatorLib/Properties/AssemblyInfo.fs"
        [   AssemblyInfo.Title "Calculator library"
            AssemblyInfo.Description "Sample project for FAKE - F# MAKE"
            AssemblyInfo.Guid "EE5621DB-B86B-44eb-987F-9C94BCC98441"
            AssemblyInfo.Product "Calculator"
            AssemblyInfo.Version version
            AssemblyInfo.FileVersion version]

    MSBuild.runRelease id buildDir "Build" appReferences
        |> Trace.logItems "AppBuild-Output: "
)

As you can see generating an AssemblyInfo.cs file is pretty easy with FAKE. You can read more about the C# and F# AssemblyInfo tasks in the API docs.

Setting the version no.

The version parameter can be declared as a property or fetched from a build server like TeamCity:

1: 
2: 
3: 
4: 

let version =
  match BuildServer.buildServer with
  | TeamCity -> buildVersion
  | _ -> "0.2"

alt text

Storing the githash in the AssemblyInfo

Storing the githash with the assembly can make it easier to identify exactly what code is running. There isn't an attribute that directly fits with doing this, but one way is by storing it as Metadata (warning: this attribute is only available in .NET 4.5 and above)

If your solution is inside a git repository you can get the git hash like this (remember to open Fake.Git):

1: 

let commitHash = Information.getCurrentHash()

And set like this:

1: 

AssemblyInfo.Metadata("githash", commitHash)

One of the easiest ways to retrieve this hash is to load use a reflector program, like ILSpy:

alt text

Using the SolutionInfo approach

Some companies split their AssemblyInfo into a SolutionInfo.cs which is shared by all projects and a specific AssemblyInfo per project which contains the product data. All versioning data is generated by the AssemblyInfo task into the SolutionInfo.cs and the AssemblyInfo files are edited manually. This could look like this:

WARNING

The picture and code within is FAKE 4 code (but the concept is very similar with fake 5)

alt text

The generated SolutionInfo.cs looks like this:

alt text

val id : x:'T -> 'T
val version : string
val TeamCity : obj
val commitHash : obj