add --depth to git-clone

Author: EdwardAngert

registry/coder/modules/git-clone/README.md

@@ -180,3 +180,20 @@ module "git-clone" {
   base_dir    = "~/projects/coder"
 }
 ```
+
+## Git shallow clone
+
+Limit the clone history to speed-up workspace startup by setting `depth`.
+
+When `depth` is greater than `0` the module runs `git clone --depth <depth>`.
+If not defined, the default, `0`, performs a full clone.
+
+```tf
+module "git-clone" {
+  count    = data.coder_workspace.me.start_count
+  source   = "registry.coder.com/modules/git-clone/coder"
+  version  = "1.0.18"
+  agent_id = coder_agent.example.id
+  url   = "https://github.com/coder/coder"
+  depth = 1                          # shallow clone
+}

registry/coder/modules/git-clone/main.tf

@@ -56,6 +56,12 @@ variable "folder_name" {
   default     = ""
 }
 
+variable "depth" {
+  description = "If > 0, perform a shallow clone using this depth."
+  type        = number
+  default     = 0
+}
+
 locals {
   # Remove query parameters and fragments from the URL
   url = replace(replace(var.url, "/\\?.*/", ""), "/#.*/", "")
@@ -113,6 +119,7 @@ resource "coder_script" "git_clone" {
     CLONE_PATH = local.clone_path,
     REPO_URL : local.clone_url,
     BRANCH_NAME : local.branch_name,
+    DEPTH = var.depth,
   })
   display_name       = "Git Clone"
   icon               = "/icon/git.svg"

registry/coder/modules/git-clone/run.sh

@@ -5,6 +5,7 @@ CLONE_PATH="${CLONE_PATH}"
 BRANCH_NAME="${BRANCH_NAME}"
 # Expand home if it's specified!
 CLONE_PATH="$${CLONE_PATH/#\~/$${HOME}}"
+DEPTH="${DEPTH}"
 
 # Check if the variable is empty...
 if [ -z "$REPO_URL" ]; then
@@ -36,10 +37,18 @@ fi
 if [ -z "$(ls -A "$CLONE_PATH")" ]; then
   if [ -z "$BRANCH_NAME" ]; then
     echo "Cloning $REPO_URL to $CLONE_PATH..."
-    git clone "$REPO_URL" "$CLONE_PATH"
+    if [ "$DEPTH" -gt 0 ]; then
+      git clone --depth "$DEPTH" "$REPO_URL" "$CLONE_PATH"
+    else
+      git clone "$REPO_URL" "$CLONE_PATH"
+    fi
   else
     echo "Cloning $REPO_URL to $CLONE_PATH on branch $BRANCH_NAME..."
-    git clone "$REPO_URL" -b "$BRANCH_NAME" "$CLONE_PATH"
+    if [ "$DEPTH" -gt 0 ]; then
+      git clone --depth "$DEPTH" -b "$BRANCH_NAME" "$REPO_URL" "$CLONE_PATH"
+    else
+      git clone "$REPO_URL" -b "$BRANCH_NAME" "$CLONE_PATH"
+    fi
   fi
 else
   echo "$CLONE_PATH already exists and isn't empty, skipping clone!"