update documentation with new feature

This commit is contained in:
2024-06-06 16:13:36 +02:00
parent 27a962ff27
commit eb46c7d2e9

View File

@@ -86,11 +86,16 @@ Example:
```
files::git:
/var/test/container-images:
ensure: latest
url: 'https://git.psi.ch/linux-infra/container_images.git'
revision: 'main'
```
If the `revision` is missing, it will initialize the checkout with the default branch, but after leave the checkout as is and not try to ensure that it is on given revision (branch, tag or commit).
If the `ensure` is missing, it will initialize the checkout with the default branch, but afterwards leave the checkout as is and not try to ensure that it is on a given revision (branch, tag or commit).
Possible values for `ensure` are: present, bare, mirror, absent, latest .
More details on the possible values of ensure you can find in [this documentation](https://forge.puppet.com/modules/puppetlabs/vcsrepo/reference#ensure)
Note that submodules are automatically initialized.