add `shallow` option to git source type

1 files changed, 4 insertions, 0 deletions

diff --git a/README.md b/README.md
index d6f921f..70ba3dc 100644
--- a/README.md
+++ b/README.md
@@ -242,6 +242,10 @@ Supported attributes:
 * `clean.exclude` -
   List of patterns that should be excluded from Git cleaning.
 
+* `shallow` (optional)
+  boolean that controls whether only the requested commit ref. should be fetched
+  instead of the whole history, to save disk space and bandwith. Defaults to `false`.
+
 
 ### `pass`