From 9b9882813aeaca46b29e37880acd8bf8508b74e9 Mon Sep 17 00:00:00 2001 From: Konrad Bucheli Date: Tue, 9 Apr 2024 16:41:01 +0200 Subject: [PATCH] document what happens when revision is missing on git checkout --- admin-guide/configuration/distribute_files.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/admin-guide/configuration/distribute_files.md b/admin-guide/configuration/distribute_files.md index a6409b70..2cf0bf2c 100644 --- a/admin-guide/configuration/distribute_files.md +++ b/admin-guide/configuration/distribute_files.md @@ -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