Skip to content

Commit d1ef67c

Browse files
authored
Merge pull request #473 from buildkite-plugins/sup-3533-docker-compose-issue-471-image-name-disappearing-in-v5
doc: clarify upgrade path to v5 — image-repository and image-name attrs
2 parents cff439e + a2fbf6c commit d1ef67c

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

docs/upgrading-to-v5.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The plugin should print out the override file used in the step's logs for you to
4444

4545
As per the documentation, the images you want to use as cache must have been built with the `BUILDKIT_INLINE_CACHE=1` build argument. Otherwise, the manifest used by docker to determine if the image contains layers that could be useful to pull will not be present and will not be used.
4646

47-
Note that docker silently ignores any `cache-from` configuration that is not valid or can not be used.
47+
Note that docker silently ignores any `cache-from` configuration that is not valid or can not be used.
4848

4949
## `image-repository` and/or `image-name`
5050

@@ -53,6 +53,19 @@ These options were used to push images in `build` steps.
5353
You need to:
5454
* delete these options
5555
* add a `push` or `run` on the very same step
56+
* combine them into a single entry in the format `repository:tag`
57+
58+
59+
Example change:
60+
```diff
61+
- - docker-compose#v4.16.0:
62+
+ - docker-compose#v5.0.0:
63+
build: base
64+
- image-name: image-name-build_id
65+
- image-repository: image-repo-host/builds
66+
push:
67+
+ - image-repo-host/builds:image-name-build_id
68+
```
5669

5770
## `cli-version`
5871

@@ -66,4 +79,4 @@ Alternatively, you can add the same variable definition to your pipeline as a gl
6679

6780
## `collapse-run-log-groups`
6881

69-
Just rename the option to `collapse-logs`
82+
Just rename the option to `collapse-logs`

0 commit comments

Comments
 (0)