Skip to content

Commit da8354b

Browse files
authored
Merge pull request #94948 from openshift-cherrypick-robot/cherry-pick-94384-to-pipelines-docs-1.19
[pipelines-docs-1.19] [RHDEVDOCS-6457] Unify the format of step actions parameters
2 parents 2f574e8 + 63e3f94 commit da8354b

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

modules/op-resolver-stepactions-ref.adoc

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -164,13 +164,13 @@ spec:
164164
- name: kind
165165
value: stepaction
166166
params:
167-
- name: patterns
167+
- name: PATTERNS
168168
value: $(params.cachePatterns)
169-
- name: source
169+
- name: SOURCE
170170
value: oci://$(params.registry):{{hash}}
171-
- name: cachePath
171+
- name: CACHE_PATH
172172
value: $(workspaces.source.path)/cache
173-
- name: workingdir
173+
- name: WORKING_DIR
174174
value: $(workspaces.source.path)/repo
175175
- name: run-build
176176
image: $(params.image)
@@ -193,31 +193,31 @@ spec:
193193
- name: kind
194194
value: stepaction
195195
params:
196-
- name: patterns
196+
- name: PATTERNS
197197
value: $(params.cachePatterns)
198-
- name: target
198+
- name: TARGET
199199
value: oci://$(params.registry):{{hash}}
200-
- name: cachePath
200+
- name: CACHE_PATH
201201
value: $(workspaces.source.path)/cache
202-
- name: workingdir
202+
- name: WORKING_DIR
203203
value: $(workspaces.source.path)/repo
204-
- name: force-cache-upload
204+
- name: FORCE_CACHE_UPLOAD
205205
value: $(params.force-cache-upload)
206206
----
207207

208208
.Supported parameters for the `cache-fetch` step action
209209
[cols="1,2,1,1",options="header"]
210210
|===
211211
| Parameter | Description | Type | Default value
212-
|`patterns` |Regular expression for selecting files to compute the hash. For example, for a Go project, you can use `go.mod` files to compute the cache, and then the value of this parameter is `pass:[**]/go.sum` (where `pass:[**]` accounts for subdirectories of any depth). | `array` |
213-
|`source` |Source URI for fetching the cache; use `{{hash}}` to specify the cache hash. The supported types are `oci` (example: `oci://quay.io/example-user/go-cache:{{hash}}`) and `s3` (example: `s3://example-bucket/{{hash}}`) | `string` |
214-
|`cachePath` |Path for extracting the cache content. Normally this path is in a workspace. | `string` |
215-
|`workingDir` |Path where the files for calculating the hash are located. | `string` |
216-
|`insecure` |If `"true"`, use insecure mode for fetching the cache. | `string` |`"false"`
217-
|`googleCredentialsPath` |The path where Google credentials are located. Ignored if empty. | `string` |
218-
|`awsConfigFile` |Path to the AWS configuration file. Ignored if empty. | `string` |
219-
|`awsCredentialFile` |Path to the AWS credentials file. Ignored if empty. | `string` |
220-
|`blobQueryParams` |Blob query parameters for configuring S3, GCS, or Azure. Use these optional parameters for additional features such as S3 acceleration, FIPS, or path-style addressing. | `string` |
212+
|`PATTERNS` |Regular expression for selecting files to compute the hash. For example, for a Go project, you can use `go.mod` files to compute the cache, and then the value of this parameter is `pass:[**]/go.sum` (where `pass:[**]` accounts for subdirectories of any depth). | `array` |
213+
|`SOURCE` |Source URI for fetching the cache; use `{{hash}}` to specify the cache hash. The supported types are `oci` (example: `oci://quay.io/example-user/go-cache:{{hash}}`) and `s3` (example: `s3://example-bucket/{{hash}}`) | `string` |
214+
|`CACHE_PATH` |Path for extracting the cache content. Normally this path is in a workspace. | `string` |
215+
|`WORKING_DIR` |Path where the files for calculating the hash are located. | `string` |
216+
|`INSECURE` |If `"true"`, use insecure mode for fetching the cache. | `string` |`"false"`
217+
|`GOOGLE_APPLICATION_CREDENTIALS` |The path where Google credentials are located. Ignored if empty. | `string` |
218+
|`AWS_CONFIG_FILE` |Path to the AWS configuration file. Ignored if empty. | `string` |
219+
|`AWS_SHARED_CREDENTIALS_FILE` |Path to the AWS credentials file. Ignored if empty. | `string` |
220+
|`BLOB_QUERY_PARAMS` |Blob query parameters for configuring S3, GCS, or Azure. Use these optional parameters for additional features such as S3 acceleration, FIPS, or path-style addressing. | `string` |
221221
|===
222222

223223
.Results that the `cache-fetch` step action returns
@@ -232,17 +232,17 @@ spec:
232232
[cols="1,2,1,1",options="header"]
233233
|===
234234
| Parameter | Description | Type | Default value
235-
|`patterns` |Regular expression for selecting files to compute the hash. For example, for a Go project, you can use `go.mod` files to compute the cache, and then the value of this parameter is `pass:[**]/go.sum` (where `pass:[**]` accounts for subdirectories of any depth). | `array` |
236-
|`target` |Target URI for uploading the cache; use `{{hash}}` to specify the cache hash. The supported types are `oci` (example: `oci://quay.io/example-user/go-cache:{{hash}}`) and `s3` (example: `s3://example-bucket/{{hash}}`) | `string` |
237-
|`cachePath` |Path for cache content, which the step packs into the image. Normally this path is in a workspace. | `string` |
238-
|`workingDir` |Path where the files for calculating the hash are located. | `string` |
239-
|`insecure` |If `"true"`, use insecure mode for uploading the cache. | `string` |`"false"`
240-
|`fetched` |If `"true"`, the cache for this hash was already fetched. | `string` |`"false"`
241-
|`force-cache-upload` |If `"true"`, the step uploads the cache even if it was fetched previously. | `string` |`"false"`
242-
|`googleCredentialsPath` |The path where Google credentials are located. Ignored if empty. | `string` |
243-
|`awsConfigFile` |Path to the AWS configuration file. Ignored if empty. | `string` |
244-
|`awsCredentialFile` |Path to the AWS credentials file. Ignored if empty. | `string` |
245-
|`blobQueryParams` |Blob query parameters for configuring S3, GCS, or Azure. Use these optional parameters for additional features such as S3 acceleration, FIPS, or path-style addressing. | `string` |
235+
|`PATTERNS` |Regular expression for selecting files to compute the hash. For example, for a Go project, you can use `go.mod` files to compute the cache, and then the value of this parameter is `pass:[**]/go.sum` (where `pass:[**]` accounts for subdirectories of any depth). | `array` |
236+
|`TARGET` |Target URI for uploading the cache; use `{{hash}}` to specify the cache hash. The supported types are `oci` (example: `oci://quay.io/example-user/go-cache:{{hash}}`) and `s3` (example: `s3://example-bucket/{{hash}}`) | `string` |
237+
|`CACHE_PATH` |Path for cache content, which the step packs into the image. Normally this path is in a workspace. | `string` |
238+
|`WORKING_DIR` |Path where the files for calculating the hash are located. | `string` |
239+
|`INSECURE` |If `"true"`, use insecure mode for uploading the cache. | `string` |`"false"`
240+
|`FETCHED` |If `"true"`, the cache for this hash was already fetched. | `string` |`"false"`
241+
|`FORCE_CACHE_UPLOAD` |If `"true"`, the step uploads the cache even if it was fetched previously. | `string` |`"false"`
242+
|`GOOGLE_APPLICATION_CREDENTIALS` |The path where Google credentials are located. Ignored if empty. | `string` |
243+
|`AWS_CONFIG_FILE` |Path to the AWS configuration file. Ignored if empty. | `string` |
244+
|`AWS_SHARED_CREDENTIALS_FILE` |Path to the AWS credentials file. Ignored if empty. | `string` |
245+
|`BLOB_QUERY_PARAMS` |Blob query parameters for configuring S3, GCS, or Azure. Use these optional parameters for additional features such as S3 acceleration, FIPS, or path-style addressing. | `string` |
246246
|===
247247

248248
The `cache-upload` step action returns no results.

0 commit comments

Comments
 (0)