Forge Home

vcs_deploy

Deploys VCS repos

10,159 downloads

9,952 latest version

1.5 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.0.2 (latest)
  • 0.0.1
released Jun 24th 2014

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'gbrown-vcs_deploy', '0.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add gbrown-vcs_deploy
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install gbrown-vcs_deploy --version 0.0.2

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

gbrown/vcs_deploy — version 0.0.2 Jun 24th 2014

VCS Deploy puppet module

A puppet module to deploy vcs repos onto a server.

Usage

The config class takes $repos as a parameter which should be a hash of vscrepo types. This is done as the class wraps this with create_resources function to allow for creation of an arbitrary number of git repos. Note for the vcsrepo type the namevar is the location of where the repo will be checked out.

Example:

Deploy two git repos from example.com

  • The foo repo is deployed to /opt/code_foo from origin/master

  • The bar repo is deployed to /opt/code_bar from the 2.0 tag

include vcs_deploy

$repos =  {
            '/opt/code_foo' => {
              source  => 'git://example.com/foo.git',
            },
            '/opt/code_bar' => {
              source    => 'git://example.com/bar.git',
              revision  => '2.0',
            },
          }

As this module is essentially just wrapping vcsrepo it is probably a good idea to check out https://forge.puppetlabs.com/puppetlabs/vcsrepo for more details.

Defaults

By default the provider for vcsrepo is git. This can be overridden in the $repos parameter to use SVN for example. Ensure also defaults to latest as the revision provider is intended to be used to specify a branch or commit. The default revision is origin/master. Finally there is also a require metaparameter to ensure the git package is present so vcsrepo has a provider. This is defined in the $vcs parameter, which of course can be changed to an array to ensure both SVN and git are present for example.

Requirements

This requires the puppetlabs-vcsrepo module as well as puppetlabs-stdlib.