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

Environment

Static members

Static memberDescription
Environment.Branch
Signature: string option

Get the branch of the main VCS root

Environment.BranchDisplayName
Signature: string option

Get the display name of the branch of the main VCS root as shown in TeamCity

See the documentation for more information

Environment.BuildConfigurationName
Signature: string option

The Name of the Build Configuration the current build belongs to or None if it's not on TeamCity.

Environment.BuildIsPersonal
Signature: bool

Is set to true if the build is a personal one.

Environment.BuildNumber
Signature: string option

The Build number assigned to the build by TeamCity using the build number format or None if it's not on TeamCity.

Environment.ChangedFiles
Signature: FileChange list option

Changed files (since previous build) that are included in this build

See the documentation for more information

Environment.CheckoutDirectory
Signature: string option

Get the path to the build checkout directory

Environment.IsDefaultBranch
Signature: bool

Get if the current branch of the main VCS root is the one configured as default

Environment.ProjectName
Signature: string option

The Name of the project the current build belongs to or None if it's not on TeamCity.

Environment.RecentlyFailedTests
Signature: string list option

Name of recently failing tests

See the documentation for more information

Environment.Version
Signature: string option

The Version of the TeamCity server. This property can be used to determine the build is run within TeamCity.