Merge pull request #155 from johnduarte/remove_beaker_gemfile
[puppet_vcsrepo.git] / README.BZR.markdown
1 Using vcsrepo with Bazaar
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 => bzr
12     }
13
14 To branch from an existing repository
15 -------------------------------------
16
17 Provide the `source` location:
18
19     vcsrepo { "/path/to/repo":
20         ensure   => present,
21         provider => bzr,
22         source   => 'lp:myproj'
23     }
24
25 For a specific revision, use `revision` with a valid revisionspec
26 (see `bzr help revisionspec` for more information on formatting a revision):
27
28     vcsrepo { "/path/to/repo":
29         ensure   => present,
30         provider => bzr,
31         source   => 'lp:myproj',
32         revision => 'menesis@pov.lt-20100309191856-4wmfqzc803fj300x'
33     }
34
35 For sources that use SSH (eg, `bzr+ssh://...`, `sftp://...`)
36 ------------------------------------------------------------
37
38 Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
39 to ensure they are present.  For more information, see the `require`
40 metaparameter documentation[1].
41
42 More Examples
43 -------------
44
45 For examples you can run, see `examples/bzr/`
46
47 [1]: http://docs.puppetlabs.com/references/stable/metaparameter.html#require