Skip to content

Commit 69b94f6

Browse files
authored
Merge pull request #481 from buildkite-plugins/toote_multiline_labels
Multiline labels docs
2 parents 9ecba0a + af8436e commit 69b94f6

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
@@ -293,13 +293,17 @@ The default is `true`.
293293

294294
#### `run-labels` (run only, boolean)
295295

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

298298
The default is `true`.
299299

300300
#### `build-labels` (build only, string or array)
301301

302-
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.
302+
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.
303+
304+
:warning: Important: if any `VALUE` contains a line break it will cause unexpected behaviour (see [issue #476][i476])
305+
306+
[i476]: https://github.com/buildkite-plugins/docker-compose-buildkite-plugin/issues/476
303307

304308
#### `compatibility` (boolean)
305309

0 commit comments

Comments
 (0)