summaryrefslogtreecommitdiff
path: root/README.GIT.markdown
blob: 95a9bc3c0af34e3b938284805de9f656f60c5fe5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
Using vcsrepo with Git
======================

To create a blank repository
----------------------------

Define a `vcsrepo` without a `source` or `revision`:

    vcsrepo { "/path/to/repo":
      ensure => present,
      provider => git
    }

If you're defining this for a central/"official" repository, you'll
probably want to make it a "bare" repository.  Do this by setting
`ensure` to `bare` instead of `present`:

    vcsrepo { "/path/to/repo":
        ensure => bare,
        provider => git
    }

To clone/pull a repository
----------------------------

To get the current [master] HEAD:

    vcsrepo { "/path/to/repo":
        ensure => present,
        provider => git,
        source => "git://example.com/repo.git"
    }

For a specific revision or branch (can be a commit SHA, tag or branch name):

    vcsrepo { "/path/to/repo":
        ensure => present,
        provider => git,
        source => 'git://example.com/repo.git',
        revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31'
    }

    vcsrepo { "/path/to/repo":
        ensure => present,
        provider => git,
        source => 'git://example.com/repo.git',
        revision => '1.1.2rc1'
    }

    vcsrepo { "/path/to/repo":
        ensure => present,
        provider => git,
        source => 'git://example.com/repo.git',
        revision => 'development'
    }

For sources that use SSH (eg, `username@server:...`)
----------------------------------------------------

Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
to ensure they are present.  For more information, see the `require`
metaparameter documentation[1].

More Examples
-------------

For examples you can run, see `examples/git/`

[1]: http://docs.puppetlabs.com/references/stable/metaparameter.html#require