Configuration

The gitman.yml configuration file controls which repositories are cloned.

Sources

Represents a repository to clone and options for controlling checkout.

Key	Purpose	Required	Default
`repo`	URL of the repository	Yes
`name`	Directory for checkout	Yes	(inferred)
`rev`	SHA, tag, or branch to checkout	Yes	`"main"`
`type`	`"git"` or `"git-svn"`	No	`"git"`
`params`	Additional arguments for `clone`	No	`null`
`sparse_paths`	Controls partial checkout	No	`[]`
`links`	Creates symlinks within a project	No	`[]`
`scripts`	Shell commands to run after checkout	No	`[]`

Params are passed directly to the clone command to modify behavior such as:

# Shallow clone:
params: --depth=1

# Include submodules:
params: --recurse-submodules

See using sparse checkouts for more information.

See using multiple links for more information.

Scripts can be used to run post-checkout commands such us build steps. For example:

repo: "https://github.com/koalaman/shellcheck"
scripts:
  - brew install cabal-install
  - cabal install