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

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

v5.fake.build

FileStatus Module

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

Types

Type Description

FileStatus

A type which represents a file status in git.

Functions and values

Function or value Description

FileStatus.cleanWorkingCopy repositoryDir

Full Usage: FileStatus.cleanWorkingCopy repositoryDir

Parameters:
    repositoryDir : string - The git repository.

Cleans the working copy by doing a git reset --hard and a clean -f.

repositoryDir : string

The git repository.

FileStatus.getAllFiles repositoryDir

Full Usage: FileStatus.getAllFiles repositoryDir

Parameters:
    repositoryDir : string - The git repository.

Returns: seq<FileStatus * string>

Gets all changed files in the current revision

repositoryDir : string

The git repository.

Returns: seq<FileStatus * string>

FileStatus.getChangedFiles repositoryDir revision1 revision2

Full Usage: FileStatus.getChangedFiles repositoryDir revision1 revision2

Parameters:
    repositoryDir : string - The git repository.
    revision1 : string - The first revision to use.
    revision2 : string - The second revision to use.

Returns: seq<FileStatus * string>

Gets the changed files between the given revisions

repositoryDir : string

The git repository.

revision1 : string

The first revision to use.

revision2 : string

The second revision to use.

Returns: seq<FileStatus * string>

FileStatus.getChangedFilesInWorkingCopy repositoryDir revision

Full Usage: FileStatus.getChangedFilesInWorkingCopy repositoryDir revision

Parameters:
    repositoryDir : string - The git repository.
    revision : string - The revision to use.

Returns: seq<FileStatus * string>

Gets the changed files since the given revision incl. changes in the working copy

repositoryDir : string

The git repository.

revision : string

The revision to use.

Returns: seq<FileStatus * string>

FileStatus.getConflictedFiles repositoryDir

Full Usage: FileStatus.getConflictedFiles repositoryDir

Parameters:
    repositoryDir : string - The git repository.

Returns: string list

Gets all conflicted files

repositoryDir : string

The git repository.

Returns: string list

FileStatus.getRebaseDir repositoryDir

Full Usage: FileStatus.getRebaseDir repositoryDir

Parameters:
    repositoryDir : string - The git repository.

Returns: string

Returns the current rebase directory for the given repository.

repositoryDir : string

The git repository.

Returns: string

FileStatus.isInTheMiddleOfConflictedMerge repositoryDir

Full Usage: FileStatus.isInTheMiddleOfConflictedMerge repositoryDir

Parameters:
    repositoryDir : string - The git repository.

Returns: bool

Returns true if the working copy is in a conflicted merge otherwise false

repositoryDir : string

The git repository.

Returns: bool

FileStatus.isInTheMiddleOfPatch repositoryDir

Full Usage: FileStatus.isInTheMiddleOfPatch repositoryDir

Parameters:
    repositoryDir : string - The git repository.

Returns: bool

Returns true if the given repository is in the middle of a patch process.

repositoryDir : string

The git repository.

Returns: bool

FileStatus.isInTheMiddleOfRebase repositoryDir

Full Usage: FileStatus.isInTheMiddleOfRebase repositoryDir

Parameters:
    repositoryDir : string - The git repository.

Returns: bool

Returns true if the given repository is in the middle of a rebase process.

repositoryDir : string

The git repository.

Returns: bool