Merge pull request #155 from johnduarte/remove_beaker_gemfile
[puppet_vcsrepo.git] / README.HG.markdown
1 Using vcsrepo with Mercurial
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 => hg
12     }
13
14 To clone/pull & update a repository
15 -----------------------------------
16
17 To get the default branch tip:
18
19     vcsrepo { "/path/to/repo":
20         ensure   => present,
21         provider => hg,
22         source   => "http://hg.example.com/myrepo"
23     }
24
25 For a specific changeset, use `revision`:
26
27     vcsrepo { "/path/to/repo":
28         ensure   => present,
29         provider => hg,
30         source   => "http://hg.example.com/myrepo",
31         revision => '21ea4598c962'
32     }
33
34 You can also set `revision` to a tag:
35
36     vcsrepo { "/path/to/repo":
37         ensure   => present,
38         provider => hg,
39         source   => "http://hg.example.com/myrepo",
40         revision => '1.1.2'
41     }
42
43 Check out as a user:
44
45     vcsrepo { "/path/to/repo":
46         ensure   => present,
47         provider => hg,
48         source   => "http://hg.example.com/myrepo",
49         user     => 'user'
50     }
51
52 Specify an SSH identity key:
53
54     vcsrepo { "/path/to/repo":
55         ensure   => present,
56         provider => hg,
57         source   => "ssh://hg@hg.example.com/myrepo",
58         identity => "/home/user/.ssh/id_dsa,
59     }
60
61 For sources that use SSH (eg, `ssh://...`)
62 ------------------------------------------
63
64 Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
65 to ensure they are present.  For more information, see the `require`
66 metaparameter documentation[1].
67
68 More Examples
69 -------------
70
71 For examples you can run, see `examples/hg/`
72
73 [1]: http://docs.puppetlabs.com/references/stable/metaparameter.html#require