Skip to content

Commit 8dd1a67

Browse files
authored
docs: update desciptions to include multi line arguments (#326)
* docs: update desciptions to include multi line arguments * fix: lint issues
1 parent 5491fec commit 8dd1a67

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed

src/commands/build_and_push_image.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,9 @@ parameters:
119119
extra_build_args:
120120
default: ""
121121
description: >
122-
Extra flags to pass to docker build. For examples, see
123-
https://docs.docker.com/engine/reference/commandline/build
122+
Extra flags to pass to docker build. This parameter accepts multi-line arguments.
123+
If your argument spans multiple lines, please use the Folded Block Style denoted by `>-` (e.g. extra_build_args: >-).
124+
For examples of available flags, see https://docs.docker.com/engine/reference/commandline/buildx_build
124125
type: string
125126

126127
no_output_timeout:

src/commands/build_image.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,12 @@ parameters:
4242
description: The amount of time to allow the docker command to run before timing out.
4343

4444
extra_build_args:
45-
type: string
4645
default: ""
4746
description: >
48-
Extra flags to pass to docker build. For examples, see
49-
https://docs.docker.com/engine/reference/commandline/buildx
47+
Extra flags to pass to docker build. This parameter accepts multi-line arguments.
48+
If your argument spans multiple lines, please use the Folded Block Style denoted by `>-` (e.g. extra_build_args: >-).
49+
For examples of available flags, see https://docs.docker.com/engine/reference/commandline/buildx_build
50+
type: string
5051

5152
skip_when_tags_exist:
5253
type: boolean

src/jobs/build_and_push_image.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,12 @@ parameters:
128128
type: string
129129

130130
extra_build_args:
131-
type: string
132131
default: ""
133132
description: >
134-
Extra flags to pass to docker build. For examples, see
135-
https://docs.docker.com/engine/reference/commandline/build
133+
Extra flags to pass to docker build. This parameter accepts multi-line arguments.
134+
If your argument spans multiple lines, please use the Folded Block Style denoted by `>-` (e.g. extra_build_args: >-).
135+
For examples of available flags, see https://docs.docker.com/engine/reference/commandline/buildx_build
136+
type: string
136137

137138
no_output_timeout:
138139
type: string

0 commit comments

Comments
 (0)