Skip to content

Commit a2d8cba

Browse files
committed
Address review comments
Signed-off-by: Chenxiong Qi <[email protected]>
1 parent 94f6f65 commit a2d8cba

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

docs/modules/ROOT/pages/how-tos/configuring/build-with-args.adoc

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Passing buildah arguments
22

3-
{ProductName} buildah task accepts link:https://github.com/konflux-ci/build-definitions/blob/main/task/buildah/0.1/buildah.yaml#L78[`BUILD_ARGS` parameter] that allows passing build arguments to the underlying `buildah` command via `--build-arg` flag. To do this, make the following changes to the PipelineRuns under the `.tekton/` directory:
3+
{ProductName} buildah task accepts link:https://github.com/konflux-ci/build-definitions/blob/main/task/buildah/0.1/buildah.yaml#L78[`BUILD_ARGS` parameter] that allows passing build arguments to the underlying `buildah` command through `--build-arg` flag. To enable this, make the following changes to the PipelineRuns under the `.tekton/` directory:
44

55
. Define a `build-args` Pipeline parameter (if not already present) in `.spec.pipelineSpec.params` to accept the passed-in build arguments.
66

@@ -38,7 +38,7 @@ spec:
3838
The value can also be in form `tasks.<taskName>.results.<resultName>[*]` if it is generated by another task dynamically.
3939

4040
+
41-
An advanced example of it would be, you can do more creative things with the `BUILD_ARGS` parameter like this snippet of a pipeline that allows passing `build-args` via the pipeline parameter (as described above) but also incorporates `build-args` generated dynamically by other tasks:
41+
For example, you can do more creative things with the `BUILD_ARGS` parameter like this snippet of a pipeline that allows passing `build-args` through the pipeline parameter (as described above) but also incorporates `build-args` generated dynamically by other tasks:
4242

4343
+
4444
[source,yaml]
@@ -62,9 +62,9 @@ spec:
6262
--
6363

6464
+
65-
Please note that the value of `BUILD_ARGS` is in the correct syntax described in link:https://tekton.dev/docs/pipelines/variables/[Variable Substitutions Supported by Tasks and Pipelines].
65+
NOTE: Ensure that the value of `BUILD_ARGS` has the correct syntax as described in link:https://tekton.dev/docs/pipelines/variables/[Variable Substitutions Supported by Tasks and Pipelines].
6666

67-
. Pass desired build arguments in the PipelineRun `.spec.params`:
67+
. Pass the desired build arguments in the PipelineRun `.spec.params`:
6868

6969
+
7070
[source,yaml]
@@ -73,8 +73,5 @@ spec:
7373
params:
7474
# ...
7575
- name: build-args
76-
value: ["ARG1=val", "ARG2=val"]
76+
value: ["ARG1=val", "ARG2=val"] # Add real argument name and value of each build argument
7777
--
78-
79-
+
80-
Replace with real argument name and value of each build argument.

0 commit comments

Comments
 (0)