Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

FAKE0001 Use the Fake.Tools.GitVersion module instead

GitVersionHelper

Containts helper function for GitVersion - a tool to help you achieve Semantic Versioning on your project.

To install GitVersion.exe on Windows, start PowerShell as Administrator and run choco install gitversion.portable -s https://chocolatey.org/api/v2" For Mac and Unix, install the NuGet version.

Nested types and modules

TypeDescription
GitVersionProperties
OBSOLETE

FAKE0001 Use the Fake.Tools.GitVersion module instead
GitversionParams
OBSOLETE

FAKE0001 Use the Fake.Tools.GitVersion module instead

Functions and values

Function or valueDescription
GitVersion(setParams)
Signature: setParams:(GitversionParams -> GitversionParams) -> GitVersionProperties
Attributes:
[<Obsolete("FAKE0001 Use the Fake.Tools.GitVersion module instead. Function GitVersion.generateProperties")>]
OBSOLETE

FAKE0001 Use the Fake.Tools.GitVersion module instead. Function GitVersion.generateProperties

Runs GitVersion on a .NET project file.

Parameters

  • setParams - Function used to manipulate the GitversionDefaults value.

Sample

1: 
2: 

 GitVersion id // Use Defaults
 GitVersion (fun p -> { p with ToolPath = currentDirectory @@ "tools" }
val id : x:'T -> 'T
GitversionDefaults
Signature: GitversionParams
Attributes:
[<Obsolete("FAKE0001 Use the Fake.Tools.GitVersion module instead")>]
OBSOLETE

FAKE0001 Use the Fake.Tools.GitVersion module instead