ProjectForge.Get.Git

Functions needed for getting templates from remote git repositories

Documentation

data GitCloneArgs

A limited set of arguments for git clone that correspond to the following command:

git clone 
   --branch OptionalBranch
   --depth OptionalDepth 
   repository 
   directory

Constructors

MkGitCloneArgs

Fields

• repository :: !GitURL

  git clone repository

• directory :: !FilePath

  git clone directory

• branch :: !(Maybe Branch)

  git clone branch

• depth :: !(Maybe Integer)

  git clone depth

Instances

Show GitCloneArgs

Defined in ProjectForge.Get.Git

Methods

showsPrec :: Int -> GitCloneArgs -> ShowS

show :: GitCloneArgs -> String

showList :: [GitCloneArgs] -> ShowS

Eq GitCloneArgs

Defined in ProjectForge.Get.Git

Methods

(==) :: GitCloneArgs -> GitCloneArgs -> Bool

(/=) :: GitCloneArgs -> GitCloneArgs -> Bool

type GitURL = String

A git url as a String.

type Branch = String

A git branch as a String.

gitClone :: GitCloneArgs -> ProcessConfig () () ()

A ProcessConfig for:

git clone 

NOTE: According to the [`typed-process` documentaiton](https:/github.comfpco/typed-process#readme), "it's highly recommended that you compile any program using this library with the multi-threaded runtime, usually by adding ghc-options: -threaded to your executable stanza in your cabal or package.yaml file. The single-threaded runtime necessitates some inefficient polling to be used under the surface."