Skip to content

[pipelines-docs-1.18] [RHDEVDOCS-6457] Unify the format of step actions parameters #94949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 18, 2025
Merged

[pipelines-docs-1.18] [RHDEVDOCS-6457] Unify the format of step actions parameters #94949

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions modules/op-resolver-stepactions-ref.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,13 +164,13 @@ spec:
- name: kind
value: stepaction
params:
- name: patterns
- name: PATTERNS
value: $(params.cachePatterns)
- name: source
- name: SOURCE
value: oci://$(params.registry):{{hash}}
- name: cachePath
- name: CACHE_PATH
value: $(workspaces.source.path)/cache
- name: workingdir
- name: WORKING_DIR
value: $(workspaces.source.path)/repo
- name: run-build
image: $(params.image)
Expand All @@ -193,31 +193,31 @@ spec:
- name: kind
value: stepaction
params:
- name: patterns
- name: PATTERNS
value: $(params.cachePatterns)
- name: target
- name: TARGET
value: oci://$(params.registry):{{hash}}
- name: cachePath
- name: CACHE_PATH
value: $(workspaces.source.path)/cache
- name: workingdir
- name: WORKING_DIR
value: $(workspaces.source.path)/repo
- name: force-cache-upload
- name: FORCE_CACHE_UPLOAD
value: $(params.force-cache-upload)
----

.Supported parameters for the `cache-fetch` step action
[cols="1,2,1,1",options="header"]
|===
| Parameter | Description | Type | Default value
|`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` |
|`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` |
|`cachePath` |Path for extracting the cache content. Normally this path is in a workspace. | `string` |
|`workingDir` |Path where the files for calculating the hash are located. | `string` |
|`insecure` |If `"true"`, use insecure mode for fetching the cache. | `string` |`"false"`
|`googleCredentialsPath` |The path where Google credentials are located. Ignored if empty. | `string` |
|`awsConfigFile` |Path to the AWS configuration file. Ignored if empty. | `string` |
|`awsCredentialFile` |Path to the AWS credentials file. Ignored if empty. | `string` |
|`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` |
|`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` |
|`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` |
|`CACHE_PATH` |Path for extracting the cache content. Normally this path is in a workspace. | `string` |
|`WORKING_DIR` |Path where the files for calculating the hash are located. | `string` |
|`INSECURE` |If `"true"`, use insecure mode for fetching the cache. | `string` |`"false"`
|`GOOGLE_APPLICATION_CREDENTIALS` |The path where Google credentials are located. Ignored if empty. | `string` |
|`AWS_CONFIG_FILE` |Path to the AWS configuration file. Ignored if empty. | `string` |
|`AWS_SHARED_CREDENTIALS_FILE` |Path to the AWS credentials file. Ignored if empty. | `string` |
|`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` |
|===

.Results that the `cache-fetch` step action returns
Expand All @@ -232,17 +232,17 @@ spec:
[cols="1,2,1,1",options="header"]
|===
| Parameter | Description | Type | Default value
|`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` |
|`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` |
|`cachePath` |Path for cache content, which the step packs into the image. Normally this path is in a workspace. | `string` |
|`workingDir` |Path where the files for calculating the hash are located. | `string` |
|`insecure` |If `"true"`, use insecure mode for uploading the cache. | `string` |`"false"`
|`fetched` |If `"true"`, the cache for this hash was already fetched. | `string` |`"false"`
|`force-cache-upload` |If `"true"`, the step uploads the cache even if it was fetched previously. | `string` |`"false"`
|`googleCredentialsPath` |The path where Google credentials are located. Ignored if empty. | `string` |
|`awsConfigFile` |Path to the AWS configuration file. Ignored if empty. | `string` |
|`awsCredentialFile` |Path to the AWS credentials file. Ignored if empty. | `string` |
|`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` |
|`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` |
|`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` |
|`CACHE_PATH` |Path for cache content, which the step packs into the image. Normally this path is in a workspace. | `string` |
|`WORKING_DIR` |Path where the files for calculating the hash are located. | `string` |
|`INSECURE` |If `"true"`, use insecure mode for uploading the cache. | `string` |`"false"`
|`FETCHED` |If `"true"`, the cache for this hash was already fetched. | `string` |`"false"`
|`FORCE_CACHE_UPLOAD` |If `"true"`, the step uploads the cache even if it was fetched previously. | `string` |`"false"`
|`GOOGLE_APPLICATION_CREDENTIALS` |The path where Google credentials are located. Ignored if empty. | `string` |
|`AWS_CONFIG_FILE` |Path to the AWS configuration file. Ignored if empty. | `string` |
|`AWS_SHARED_CREDENTIALS_FILE` |Path to the AWS credentials file. Ignored if empty. | `string` |
|`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` |
|===

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