Merge pull request #202 from buildkite-plugins/add-skip-checkout-option

Add skip checkout option

README.md

@@ -357,6 +357,10 @@ Set the shell to use for the command. Set it to `false` to pass the command dire
 
 Example: `[ "powershell", "-Command" ]`
 
+### `skip-checkout` (optional, run only)
+
+Whether to skip the repository checkout phase. This is useful for steps that use a pre-built image. This will fail if there is no pre-built image.
+
 ### `workdir` (optional, run only)
 
 Specify the container working directory via `docker-compose run --workdir`.

hooks/pre-checkout

@@ -0,0 +1,15 @@
+#!/bin/bash
+set -ueo pipefail
+
+DIR="$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd)"
+
+# shellcheck source=lib/shared.bash
+. "$DIR/../lib/shared.bash"
+# shellcheck source=lib/metadata.bash
+. "$DIR/../lib/metadata.bash"
+
+# skip checkout if skip-checkout is set
+if [[ "$(plugin_read_config SKIP_CHECKOUT "false")" == "true" ]] ; then
+  export BUILDKITE_REPO=""
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_REQUIRE_PREBUILD="true"
+fi

plugin.yml

@@ -45,6 +45,8 @@ configuration:
       minimum: 1
     command:
       type: array
+    skip-checkout:
+      type: boolean
     leave-volumes:
       type: boolean
     no-cache: