git - stage files from a git repository
Host dependencies:
git
Usage:
# Specify the git source kind
kind: git
# Optionally specify a relative staging directory
# directory: path/to/stage
# Specify the repository url, using an alias defined
# in your project configuration is recommended.
url: upstream:foo.git
# Optionally specify a symbolic tracking branch or tag, this
# will be used to update the 'ref' when refreshing the pipeline.
track: master
# Optionally specify the ref format used for tracking.
# The default is 'sha1' for the raw commit hash.
# If you specify 'git-describe', the commit hash will be prefixed
# with the closest tag.
ref-format: sha1
# Specify the commit ref, this must be specified in order to
# checkout sources and build, but can be automatically updated
# if the 'track' attribute was specified.
ref: d63cbb6fdc0bbdadc4a1b92284826a6d63a7ebcd
# Optionally specify whether submodules should be checked-out.
# If not set, this will default to 'True'
checkout-submodules: True
# If your repository has submodules, explicitly specifying the
# url from which they are to be fetched allows you to easily
# rebuild the same sources from a different location. This is
# especially handy when used with project defined aliases which
# can be redefined at a later time.
# You may also explicitly specify whether to check out this
# submodule. If 'checkout' is set, it will override
# 'checkout-submodules' with the value set below.
submodules:
plugins/bar:
url: upstream:bar.git
checkout: True
plugins/baz:
url: upstream:baz.git
checkout: False
Configurable Warnings:
This plugin provides the following configurable warnings:
git:inconsistent-submodule
- A submodule present in the git repository’s .gitmodules was never added with git submodule add.git:unlisted-submodule
- A submodule is present in the git repository but was not specified in the source configuration and was not disabled for checkout.Note
The
git:unlisted-submodule
warning is available since format version 20git:invalid-submodule
- A submodule is specified in the source configuration but does not exist in the repository.Note
The
git:invalid-submodule
warning is available since format version 20
This plugin also utilises the following configurable core warnings
:
ref-not-in-track
- The provided ref was not found in the provided track in the element’s git repository.