Removes trailing whitespace
[puppet_vcsrepo.git] / README.GIT.markdown
1 Using vcsrepo with Git
2 ======================
3
4 To create a blank repository
5 ----------------------------
6
7 Define a `vcsrepo` without a `source` or `revision`:
8
9     vcsrepo { "/path/to/repo":
10       ensure => present,
11       provider => git
12     }
13
14 If you're defining this for a central/"official" repository, you'll
15 probably want to make it a "bare" repository.  Do this by setting
16 `ensure` to `bare` instead of `present`:
17
18     vcsrepo { "/path/to/repo":
19         ensure => bare,
20         provider => git
21     }
22
23 To clone/pull a repository
24 ----------------------------
25
26 To get the current [master] HEAD:
27
28     vcsrepo { "/path/to/repo":
29         ensure => present,
30         provider => git,
31         source => "git://example.com/repo.git"
32     }
33
34 For a specific revision or branch (can be a commit SHA, tag or branch name):
35
36     vcsrepo { "/path/to/repo":
37         ensure => present,
38         provider => git,
39         source => 'git://example.com/repo.git',
40         revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31'
41     }
42
43     vcsrepo { "/path/to/repo":
44         ensure => present,
45         provider => git,
46         source => 'git://example.com/repo.git',
47         revision => '1.1.2rc1'
48     }
49
50     vcsrepo { "/path/to/repo":
51         ensure => present,
52         provider => git,
53         source => 'git://example.com/repo.git',
54         revision => 'development'
55     }
56
57 For sources that use SSH (eg, `username@server:...`)
58 ----------------------------------------------------
59
60 Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
61 to ensure they are present.  For more information, see the `require`
62 metaparameter documentation[1].
63
64 More Examples
65 -------------
66
67 For examples you can run, see `examples/git/`
68
69 [1]: http://docs.reductivelabs.com/references/stable/metaparameter.html#require
70