Submodule

Contains helper functions which allow to deal with git submodules.

Nested types and modules

TypeDescription
Submodule

This record represents a git submodule binding.

Functions and values

Function or valueDescription
add(...)
Signature: superRepositoryDir:string -> remotePath:string -> localPath:string -> branch:string -> unit

Adds a submodule to the given super repository.

Parameters

  • superRepositoryDir - The super repository.
  • remotePath - The path to the remote repository of the submodule.
  • localPath - The local path to the submodule.
  • branch - The branch to clone. (can be null)
getSubModules(repositoryDir)
Signature: repositoryDir:string -> seq<Submodule>

Gets all submodules from the given repository directory.

init superRepositoryDir name
Signature: superRepositoryDir:string -> name:string -> unit

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

Parameters

  • superRepositoryDir - The super repository.
  • name - The name of the new repository.