summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorAaron Stone <aaron@serendipity.cx>2015-01-18 21:43:27 -0800
committerAaron Stone <aaron@serendipity.cx>2015-01-18 21:43:27 -0800
commitd08d16bd71e10f439dfa3ff92626aeb38aa95303 (patch)
tree1ac586b7e4561c85590266c7e6ff052dc2e2a6b2 /README.markdown
parentde7bf159c721a1461b7d8a61e98fd024344c7eb5 (diff)
parentdfe5f9cc316a43793da2cb1c4adbc66503907460 (diff)
Merge pull request #218 from dduvnjak/master
Add submodules feature to git provider
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.markdown b/README.markdown
index cefa50b..6c6f0a5 100644
--- a/README.markdown
+++ b/README.markdown
@@ -145,6 +145,15 @@ To keep the repository at the latest revision (**WARNING:** this will always ove
revision => 'master',
}
+To clone the repository but skip initialiazing submodules,
+
+ vcsrepo { "/path/to/repo":
+ ensure => latest,
+ provider => git,
+ source => 'git://example.com/repo.git',
+ submodules => false,
+ }
+
#####Sources that use SSH
When your source uses SSH, such as 'username@server:…', you can manage your SSH keys with Puppet using the [require](http://docs.puppetlabs.com/references/stable/metaparameter.html#require) metaparameter in `vcsrepo` to ensure they are present.
@@ -483,6 +492,7 @@ The vcsrepo module is slightly unusual in that it is simply a type and providers
* `ssh_identity` - The provider supports a configurable SSH identity file. (Available with `git` and `hg`.)
* `user` - The provider can run as a different user. (Available with `git`, `hg` and `cvs`.)
* `p4config` - The provider support setting the P4CONFIG environment. (Available with `p4`.)
+* `submodules` - The provider supports repository submodules which can be optionally initialized. (Available with `git`.)
####Parameters
@@ -511,9 +521,9 @@ The vcsrepo module is slightly unusual in that it is simply a type and providers
####Features and Parameters by Provider
#####`git`
-**Features**: `bare_repositories`, `depth`, `multiple_remotes`, `reference_tracking`, `ssh_identity`, `user`
+**Features**: `bare_repositories`, `depth`, `multiple_remotes`, `reference_tracking`, `ssh_identity`, `user`, `submodules`
-**Parameters**: `depth`, `ensure`, `excludes`, `force`, `group`, `identity`, `owner`, `path`, `provider`, `remote`, `revision`, `source`, `user`
+**Parameters**: `depth`, `ensure`, `excludes`, `force`, `group`, `identity`, `owner`, `path`, `provider`, `remote`, `revision`, `source`, `user`, `submodules`
#####`bzr`
**Features**: `reference_tracking`