Resource Type: vcsrepo

Defined in:

lib/puppet/type/vcsrepo.rb

Providers:

hg
p4
bzr
cvs
git
svn
dummy

Overview

A local version control repository

Properties

• ensure

  Ensure the version control repository.

  Supported values:

  • present
  • bare
  • mirror
  • absent
  • latest
• includes

  Paths to be included from the repository

• module

  The repository module to manage

• revision

  The revision of the repository

  Supported values:

  • %r{^\S+$}
• skip_hooks

  Explicitly skip any global hooks for this repository.

  Supported values:

  • true
  • false
• source

  The source URI for the repository

Parameters

• basic_auth_password

  HTTP Basic Auth password

• basic_auth_username

  HTTP Basic Auth username

• branch

  The name of the branch to clone.

• compression

  Compression level

• configuration

  The configuration directory to use

• conflict

  The action to take if conflicts exist between repository and working copy

• cvs_rsh

  The value to be used for the CVS_RSH environment variable.

• depth

  The value to be used to do a shallow clone.

• excludes

  Local paths which shouldn’t be tracked by the repository

• force (defaults to: false)

  Force repository creation, destroying any files on the path in the process.

  Supported values:

  • true
  • false
  • yes
  • no
• fstype

  Filesystem type

• group

  The group/gid that owns the repository files

• http_proxy

  Sets the HTTP/HTTPS proxy for remote repo access

• identity

  SSH identity file

• keep_local_changes (defaults to: false)

  Keep local changes on files tracked by the repository when changing revision

  Supported values:

  • true
  • false
• owner

  The user/uid that owns the repository files

• p4config

  The Perforce P4CONFIG environment.

• path (namevar)

  Absolute path to repository

• provider

  The specific backend to use for this ‘vcsrepo` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

• remote (defaults to: origin)

  The remote repository to track

• safe_directory (defaults to: false)

  Marks the current directory specified by the path parameter as a safe directory.

  Supported values:

  • true
  • false
• submodules (defaults to: true)

  Initialize and update each submodule in the repository.

  Supported values:

  • true
  • false
• trust_server_cert (defaults to: false)

  Trust server certificate

  Supported values:

  • true
  • false
• umask

  Sets the umask to be used for all repo operations

• user

  The user to run for repository operations

Features

• gzip_compression —

  The provider supports explicit GZip compression levels

• basic_auth —

  The provider supports HTTP Basic Authentication

• bare_repositories —

  The provider differentiates between bare repositories and those with working copies

• filesystem_types —

  The provider supports different filesystem types

• reference_tracking —

  The provider supports tracking revision references that can change over time (eg, some VCS tags and branch names)

• ssh_identity —

  The provider supports a configurable SSH identity file

• user —

  The provider can run as a different user

• modules —

  The repository contains modules that can be chosen of

• multiple_remotes —

  The repository tracks multiple remote repositories

• configuration —

  The configuration directory to use

• cvs_rsh —

  The provider understands the CVS_RSH environment variable

• depth —

  The provider can do shallow clones or set scope limit

• branch —

  The name of the branch

• p4config —

  The provider understands Perforce Configuration

• submodules —

  The repository contains submodules which can be optionally initialized

• conflict —

  The provider supports automatic conflict resolution

• include_paths —

  The provider supports checking out only specific paths

• keep_local_changes —

  The provider supports keeping local changes on files tracked by the repository when changing revision

• safe_directory —

  The provider supports setting a safe directory. This will only be used for newer versions of git.

• hooks_allowed —

  The provider supports managing hooks for the repository operations.

• umask —

  The provider supports setting umask for repo operations

• http_proxy —

  The provider supports retrieving repos via HTTP/HTTPS over an HTTP/HTTPS proxy