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

Submodule Module

Contains helper functions which allow to deal with git submodules.

Types

Type Description

Submodule

This record represents a git submodule binding.

Functions and values

Function or value Description

Submodule.add superRepositoryDir remotePath localPath branch

Full Usage: Submodule.add superRepositoryDir remotePath localPath branch

Parameters:
    superRepositoryDir : string - The super repository.
    remotePath : string - The path to the remote repository of the submodule.
    localPath : string - The local path to the submodule.
    branch : string - The branch to clone. (can be null)

Adds a submodule to the given super repository.

superRepositoryDir : string

The super repository.

remotePath : string

The path to the remote repository of the submodule.

localPath : string

The local path to the submodule.

branch : string

The branch to clone. (can be null)

Submodule.getSubModules repositoryDir

Full Usage: Submodule.getSubModules repositoryDir

Parameters:
    repositoryDir : string - The path of the target directory.

Returns: seq<Submodule>

Gets all submodules from the given repository directory.

repositoryDir : string

The path of the target directory.

Returns: seq<Submodule>

Submodule.init superRepositoryDir name

Full Usage: Submodule.init superRepositoryDir name

Parameters:
    superRepositoryDir : string - The super repository.
    name : string - The name of the new repository.

Inits a submodule with the given name in a subfolder of the given super repository.

superRepositoryDir : string

The super repository.

name : string

The name of the new repository.