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

Use Fake.Tools.Git.Information instead

Information

Contains helper functions which can be used to retrieve status information from git.

Functions and values

Function or valueDescription
describe(repositoryDir)
Signature: repositoryDir:string -> string
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead

Gets the last git tag by calling git describe
getBranchName(repositoryDir)
Signature: repositoryDir:string -> string
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead

Gets the git branch name
getCurrentHash()
Signature: unit -> string
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead

Gets the current hash of the current repository
getCurrentSHA1(repositoryDir)
Signature: repositoryDir:string -> string
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead

Returns the SHA1 of the current HEAD
getLastTag()
Signature: unit -> string
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead

Gets the last git tag of the current repository by calling git describe
getVersion(repositoryDir)
Signature: repositoryDir:string -> string
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead

Gets the git version
isAheadOf repositoryDir rev1 rev2
Signature: repositoryDir:string -> rev1:string -> rev2:string -> bool
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead

Returns true if rev1 is ahead of rev2
isCleanWorkingCopy(repositoryDir)
Signature: repositoryDir:string -> bool
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead

Checks if the working copy is clean
isGitVersionHigherOrEqual(...)
Signature: referenceVersion:string -> bool
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead
isVersionHigherOrEqual(...)
Signature: currentVersion:string -> referenceVersion:string -> bool
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead
shortlog(repositoryDir)
Signature: repositoryDir:string -> string
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead

Gets the git log in one line
showName repositoryDir sha1
Signature: repositoryDir:string -> sha1:string -> string
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead

Returns a friendly name from a SHA1
showStatus(repositoryDir)
Signature: repositoryDir:string -> unit
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead

Shows the git status
versionRegex
Signature: Regex
Attributes:
[<Obsolete("Use Fake.Tools.Git.Information instead")>]
OBSOLETE

Use Fake.Tools.Git.Information instead