document what happens when revision is missing on git checkout

2024-04-09 16:41:01 +02:00
parent fe3fa6c75c
commit 9b9882813a
1 changed files with 3 additions and 1 deletions
@@ -79,7 +79,7 @@ The option `force: true` is only needed for directories. For a directory, if abs
 To synchronize a git repository to the host you might list them in the `files::git` hash. The key is the destination directory and the value is a hash with following options:

 - `url`: URL of the public git repository to clone
- `revision`: what branch, tag or commit-hash should be checked out
+- `revision`: what branch, tag or commit-hash should be checked out (optional)

 Example:

@@ -90,6 +90,8 @@ files::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).
+
 Note that submodules are automatically initialized.

 ## Download Files