cdist/cdist/conf/type/__git/man.rst

82 lines
1.9 KiB
ReStructuredText

cdist-type__git(7)
==================
NAME
----
cdist-type__git - Get and keep git repositories up-to-date
DESCRIPTION
-----------
This cdist type allows you to clone git repositories, track specific branches
or tags and keep up to date at your own pace.
REQUIRED PARAMETERS
-------------------
source
Specifies the git remote to clone from
OPTIONAL PARAMETERS
-------------------
state
Either "present" or "absent", defaults to "present"
branch
Check out this branch or tag to the target directory.
Default branch is "master"
group
Group to chgrp to.
mode
Unix permissions, suitable for chmod.
By default it only applies to the top-level directory.
See the mode-recursive parameter as well.
owner
User to chown to.
BOOLEAN PARAMETERS
------------------
mode-recursive
If present and --mode is passed, the given permissions will be applied
recursively to the working directory.
recursive
Passes the --recurse-submodules flag to git when cloning the repository.
shallow
Sets --depth=1 and --shallow-submodules for cloning repositories with big history.
EXAMPLES
--------
.. code-block:: sh
__git /home/services/dokuwiki --source git://github.com/splitbrain/dokuwiki.git
# Checkout cdist, stay on branch 2.1
__git /home/nico/cdist --source git@code.ungleich.ch:ungleich-public/cdist.git --branch 2.1
# If at a later stage you decide to keep up with the development version,
# cdist will change the branch and keep you up to date with:
__git /home/nico/cdist --source git@code.ungleich.ch:ungleich-public/cdist.git --branch master
AUTHORS
-------
Nico Schottelius <nico-cdist--@--schottelius.org>
Evilham <cvs--@--evilham.com>
COPYING
-------
Copyright \(C) 2012 Nico Schottelius. 2020 Evilham.
You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.