Skip to content

Commit 17ac2ad

Browse files
committed
Clarified behaviour of pre-built images example
1 parent eeb5b9b commit 17ac2ad

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

docs/examples.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,9 +177,12 @@ steps:
177177
plugins:
178178
- docker-compose#v5.3.0:
179179
run: app
180+
require-prebuild: true
180181
```
181182

182-
All `run` steps for the service `app` will automatically pull and use the pre-built image. Without this, each `Test %n` job would build its own instead.
183+
All `run` steps for the service `app` will automatically pull and use the pre-built image. Note that, for the example to work as-is, the `app` service needs to have an `image` element defined or the build/push step needs to be changed to `push: app:the_registry:the_tag` (and the agent running all the steps need to be authenticated against the registry if required).
184+
185+
Note that the `require-prebuild` option means that if no prebuilt image is found, all `Test %n` jobs will fail. Without it, if the agent the `Test %n` is running on has ever built such an image and has it appropriately tagged it may still run.
183186

184187
### Building multiple images
185188

0 commit comments

Comments
 (0)