Information (Fake)

6.0.0

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

Information Module

Namespace: Fake.Tools.Git
Assembly: Fake.Tools.Git.dll

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

Functions and values

Function or value	Description
`Information.describe repositoryDir` Full Usage: `Information.describe repositoryDir` Parameters: repositoryDir : `string` - The git repository. Returns: `string`	Gets the last git tag by calling git describe repositoryDir : `string` The git repository. Returns: `string`
`Information.getBranchName repositoryDir` Full Usage: `Information.getBranchName repositoryDir` Parameters: repositoryDir : `string` - The git repository. Returns: `string`	Gets the git branch name repositoryDir : `string` The git repository. Returns: `string`
`Information.getCurrentHash ()` Full Usage: `Information.getCurrentHash ()` Parameters: () : `unit` Returns: `string`	Gets the current hash of the current repository () : `unit` Returns: `string`
`Information.getCurrentSHA1 repositoryDir` Full Usage: `Information.getCurrentSHA1 repositoryDir` Parameters: repositoryDir : `string` - The git repository. Returns: `string`	Returns the SHA1 of the current `HEAD` repositoryDir : `string` The git repository. Returns: `string`
`Information.getLastTag ()` Full Usage: `Information.getLastTag ()` Parameters: () : `unit` Returns: `string`	Gets the last git tag of the current repository by calling git describe () : `unit` Returns: `string`
`Information.getVersion repositoryDir` Full Usage: `Information.getVersion repositoryDir` Parameters: repositoryDir : `string` - The git repository. Returns: `string`	Gets the git version repositoryDir : `string` The git repository. Returns: `string`
`Information.isAheadOf repositoryDir rev1 rev2` Full Usage: `Information.isAheadOf repositoryDir rev1 rev2` Parameters: repositoryDir : `string` - The git repository. rev1 : `string` - The first revision to use rev2 : `string` - The second revision to use Returns: `bool`	Returns true if rev1 is ahead of rev2 repositoryDir : `string` The git repository. rev1 : `string` The first revision to use rev2 : `string` The second revision to use Returns: `bool`
`Information.isCleanWorkingCopy repositoryDir` Full Usage: `Information.isCleanWorkingCopy repositoryDir` Parameters: repositoryDir : `string` - The git repository. Returns: `bool`	Checks if the working copy is clean repositoryDir : `string` The git repository. Returns: `bool`
`Information.isGitVersionHigherOrEqual referenceVersion` Full Usage: `Information.isGitVersionHigherOrEqual referenceVersion` Parameters: referenceVersion : `string` - The version to compare with Returns: `bool`	Check if the given reference version is higher or equal to found git version referenceVersion : `string` The version to compare with Returns: `bool`
`Information.shortlog repositoryDir` Full Usage: `Information.shortlog repositoryDir` Parameters: repositoryDir : `string` - The git repository. Returns: `string`	Gets the git log in one line repositoryDir : `string` The git repository. Returns: `string`
`Information.showName repositoryDir sha1` Full Usage: `Information.showName repositoryDir sha1` Parameters: repositoryDir : `string` - The git repository. sha1 : `string` - The sha1 to use Returns: `string`	Returns a friendly name from a SHA1 repositoryDir : `string` The git repository. sha1 : `string` The sha1 to use Returns: `string`
`Information.showStatus repositoryDir` Full Usage: `Information.showStatus repositoryDir` Parameters: repositoryDir : `string` - The git repository.	Shows the git status repositoryDir : `string` The git repository.