REFERENCE.md

Reference

Table of Contents

Classes

• vcsrepo::manage::git: Manage the Git source code manager package
• vcsrepo::manage::svn: Manage the Subversion source code manager package

Resource types

• vcsrepo: A local version control repository

Classes

vcsrepo::manage::git

Manage the Git source code manager package

Examples

simple include

include vcsrepo::manage::git

Parameters

The following parameters are available in the vcsrepo::manage::git class:

• package_name
• package_ensure

package_name

Data type: Variant[String[1], Array[String[1]]]

name of package to manage

Default value: 'git'

package_ensure

Data type: String[1]

ensure state of the package resource

Default value: 'installed'

vcsrepo::manage::svn

Manage the Subversion source code manager package

Examples

simple include

include vcsrepo::manage::svn

Parameters

The following parameters are available in the vcsrepo::manage::svn class:

• package_name
• package_ensure

package_name

Data type: Variant[String[1], Array[String[1]]]

name of package to manage

Default value: 'subversion'

package_ensure

Data type: String[1]

ensure state of the package resource

Default value: 'installed'

Resource types

vcsrepo

A local version control repository

Properties

The following properties are available in the vcsrepo type.

ensure

Valid values: present, bare, mirror, absent, latest

Ensure the version control repository.

includes

Paths to be included from the repository

module

The repository module to manage

revision

Valid values: %r{^\S+$}

The revision of the repository

skip_hooks

Valid values: true, false

Explicitly skip any global hooks for this repository.

source

The source URI for the repository

Parameters

The following parameters are available in the vcsrepo type.

• basic_auth_password
• basic_auth_username
• branch
• compression
• configuration
• conflict
• cvs_rsh
• depth
• excludes
• force
• fstype
• group
• http_proxy
• identity
• keep_local_changes
• owner
• p4config
• path
• provider
• remote
• safe_directory
• submodules
• trust_server_cert
• umask
• user

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

Valid values: true, false, yes, no

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

Default value: false

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

Valid values: true, false

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

Default value: 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

The remote repository to track

Default value: origin

safe_directory

Valid values: true, false

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

Default value: false

submodules

Valid values: true, false

Initialize and update each submodule in the repository.

Default value: true

trust_server_cert

Valid values: true, false

Trust server certificate

Default value: false

umask

Sets the umask to be used for all repo operations

user

The user to run for repository operations