Skip to content

Commit af8436e

Browse files
committed
Correct link and add a warning about multiline labels
1 parent 58ec2f9 commit af8436e

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -287,13 +287,17 @@ The default is `true`.
287287

288288
#### `run-labels` (run only, boolean)
289289

290-
If set to true, adds useful Docker labels to the primary container. See [Container Labels](#container-labels) for more info.
290+
If set to true, adds useful Docker labels to the primary container. See [Container Labels](docs/examples.md#container-labels) for more info.
291291

292292
The default is `true`.
293293

294294
#### `build-labels` (build only, string or array)
295295

296-
A list of KEY=VALUE that are passed through as service labels when image is being built. These will be merged with any service labels defined in the compose file.
296+
A list of `KEY=VALUE` strings that are passed through as service labels when image is being built. These will be merged with any service labels defined in the compose file.
297+
298+
:warning: Important: if any `VALUE` contains a line break it will cause unexpected behaviour (see [issue #476][i476])
299+
300+
[i476]: https://github.com/buildkite-plugins/docker-compose-buildkite-plugin/issues/476
297301

298302
#### `compatibility` (boolean)
299303

0 commit comments

Comments
 (0)