Merge pull request #20 from buildkite-plugins/SUP-5032/Add-verbose

Add verbose logging option

Author: JoeColeman95

README.md

@@ -26,12 +26,16 @@ Whether to skip ssh-keyscan step. This will skip adding each ssh public key into
 
 #### `clean_checkout` ('true' or 'false')
 
-Whether to perform aggressive repository cleanup before checkout. This option handles scenarios where interrupted or cancelled jobs leave the git repository in a corrupted state with uncommitted changes that would prevent checkout. When enabled, it performs `git reset --hard HEAD` and `git sparse-checkout disable` in addition to the normal cleanup. 
+Whether to perform aggressive repository cleanup before checkout. This option handles scenarios where interrupted or cancelled jobs leave the git repository in a corrupted state with uncommitted changes that would prevent checkout. When enabled, it performs `git reset --hard HEAD` and `git sparse-checkout disable` in addition to the normal cleanup.
 
 **⚠️ Warning:** This option will destroy ALL local changes and remove ALL untracked files. The `git clean -ffxdq` command with the `-x` flag will also remove ignored files (such as credentials, local configuration, or cache files). Only use this option when you're certain no important local data needs to be preserved.
 
 Use this option for pipeline upload jobs that don't need to preserve local changes.
 
+#### `verbose` ('true' or 'false')
+
+Enable verbose logging with bash execution tracing (`set -x`). This shows each command being executed and can help debug issues with ssh-keyscan, git operations, or other checkout problems. When enabled, you'll see detailed output including command arguments and any error messages from underlying tools.
+
 ## Example
 
 Below is an example of using sparse-checkout plugin.
@@ -41,7 +45,7 @@ steps:
   - label: "Pipeline upload"
     command: "buildkite-agent pipeline upload"
     plugins:
-      - sparse-checkout#v1.1.0:
+      - sparse-checkout#v1.2.0:
           paths:
             - .buildkite
 ```
@@ -55,7 +59,7 @@ steps:
   - label: "Pipeline upload with clean checkout"
     command: "buildkite-agent pipeline upload"
     plugins:
-      - sparse-checkout#v1.1.0:
+      - sparse-checkout#v1.2.0:
           paths:
             - .buildkite
           clean_checkout: true

hooks/checkout

@@ -7,6 +7,9 @@ DIR="$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd)"
 # shellcheck source=lib/plugin.bash
 . "$DIR/../lib/plugin.bash"
 
+VERBOSE_OPTION="$(plugin_read_config VERBOSE "false")"
+[[ "${VERBOSE_OPTION}" = "true" ]] && set -x
+
 NO_CONE_OPTION="$(plugin_read_config NO_CONE "false")"
 NO_CONE_PARAM=""
 [[ $NO_CONE_OPTION = false ]] || NO_CONE_PARAM="--no-cone"

plugin.yml

@@ -16,6 +16,9 @@ configuration:
     clean_checkout:
       type: boolean
       default: false
+    verbose:
+      type: boolean
+      default: false
   required:
     - paths
   additionalProperties: false