FAKE - F# Make - A DSL for build tasks and more FAKE
6.1.3

Lookig for older versions of the documentation, pre FAKE v6? See 

v5.fake.build

BuildServer Module

Contains functions which allow build scripts to interact with a build server.

Functions and values

Function or value Description

BuildServer.ansiColorSupport

Full Usage: BuildServer.ansiColorSupport

Returns: bool
Returns: bool

BuildServer.appVeyorBuildVersion

Full Usage: BuildServer.appVeyorBuildVersion

Returns: string

AppVeyor build number

Returns: string

BuildServer.bambooBuildNumber

Full Usage: BuildServer.bambooBuildNumber

Returns: string

Build number retrieved from Bamboo

Returns: string

BuildServer.buildServer

Full Usage: BuildServer.buildServer

Returns: BuildServer

The current build server

Returns: BuildServer

BuildServer.buildVersion

Full Usage: BuildServer.buildVersion

Returns: string

The current build version as detected from the current build server.

Returns: string

BuildServer.ccBuildLabel

Full Usage: BuildServer.ccBuildLabel

Returns: string

CruiseControl.NET Build label

Returns: string

BuildServer.gitHubActionsBuildNumber

Full Usage: BuildServer.gitHubActionsBuildNumber

Returns: string

Build number retrieved from GitHub Actions

Returns: string

BuildServer.gitlabCIBuildNumber

Full Usage: BuildServer.gitlabCIBuildNumber

Returns: string

Build number retrieved from GitLab CI

Returns: string

BuildServer.install servers

Full Usage: BuildServer.install servers

Parameters:

Install given list of build servers

servers : BuildServerInstaller list

The list of build servers to install

BuildServer.isBambooBuild

Full Usage: BuildServer.isBambooBuild

Returns: bool

Checks if we are on Bamboo

Returns: bool

BuildServer.isGitlabCI

Full Usage: BuildServer.isGitlabCI

Returns: bool

Checks if we are on GitLab CI

Returns: bool

BuildServer.isLocalBuild

Full Usage: BuildServer.isLocalBuild

Returns: bool

Is true when the current build is a local build.

Returns: bool

BuildServer.isTFBuild

Full Usage: BuildServer.isTFBuild

Returns: bool

Checks if we are on Team Foundation

Returns: bool

BuildServer.jenkinsBuildNumber

Full Usage: BuildServer.jenkinsBuildNumber

Returns: string

Build number retrieved from Jenkins

Returns: string

BuildServer.localBuildLabel

Full Usage: BuildServer.localBuildLabel

Returns: string

A constant label for local builds

Returns: string

BuildServer.tcBuildNumber

Full Usage: BuildServer.tcBuildNumber

Returns: string

Build number retrieved from TeamCity

Returns: string

BuildServer.tfBuildNumber

Full Usage: BuildServer.tfBuildNumber

Returns: string

Build number retrieved from Team Foundation

Returns: string

BuildServer.travisBuildNumber

Full Usage: BuildServer.travisBuildNumber

Returns: string

Build number retrieved from Travis

Returns: string

BuildServer.xmlOutputFile

Full Usage: BuildServer.xmlOutputFile

Returns: string

Defines the XML output file - used for build servers like CruiseControl.NET. This output file can be specified by using the *logfile* build parameter.

Returns: string