plugin-git

This plugin is automatically introduced into your pipeline as the first step. Its purpose is to clone your Git repository.

Features

• Git LFS support is enabled by default.
• Fetch tags when needed.
• Adjust submodules.

Overriding Settings

You can manually define your clone step in order to change plugin or override some of the default settings. Consult the clone section of the pipeline documentation for more information; this documentation page only describes this plugin.

clone:
  git:
    image: woodpeckerci/plugin-git
    settings:
      depth: 50
      lfs: false

Settings

Settings Name	Default	Description
depth	none	If specified, uses git's --depth option to create a shallow clone with a limited number of commits, overwritten by partial. Setting it to 0 disables shallow cloning
lfs	true	Set this to false to disable retrieval of LFS files
recursive	false	Clones submodules recursively
skip-verify	false	Skips the SSL verification
tags	false (except on tag event)	Fetches tags when set to true, default is false if event is not tag else true
submodule-overrides	none	Override submodule urls
submodule-update-remote	false	Pass the --remote flag to git submodule update
submodule-partial	true	Update submodules via partial clone (depth=1)
custom-ssl-path	none	Set path to custom cert
custom-ssl-url	none	Set url to custom cert
backoff	5sec	Change backoff duration
attempts	5	Change backoff attempts
branch	$CI_COMMIT_BRANCH	Change branch name to checkout to
partial	true (except if tags are fetched)	Only fetch the one commit and it's blob objects to resolve all files, overwrite depth with 1
home		Change HOME var for commands executed, fail if it does not exist
remote	$CI_REPO_CLONE_URL	Set the git remote url
remote-ssh	$CI_REPO_CLONE_SSH_URL	Set the git SSH remote url
sha	$CI_COMMIT_SHA	git commit hash to retrieve
ref	none	Set the git reference to retrieve
path	$CI_WORKSPACE	Set destination path to clone to
use-ssh	false	Clone using SSH
ssh-key	none	SSH key for SSH clone