Clarified skup-checkout option (closes #232)

buildkite-plugins · Oct 6, 2022 · 3698342 · 3698342
1 parent d9ccb60
commit 3698342
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -438,7 +438,9 @@ 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.
+Whether to skip the repository checkout phase. This is useful for steps that use a pre-built image and will fail if there is no pre-built image.
+
+**Important**: as the code repository will not be available in the step, you need to ensure that the docker compose file(s) are present in some way (like using artifacts) 
 
 ### `skip-pull` (optional, run only)