Skip to content

Commit f9846f7

Browse files
Paul123111Paul123111
authored
feat(RELEASE-1675): auto generate README.md files for tasks/pipelines (#1160)
Updated half the README.md files in tasks/managed. Signed-off-by: Paul Fitzgerald <pafitzge@redhat.com>
1 parent 276a673 commit f9846f7

62 files changed

Lines changed: 588 additions & 465 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎tasks/managed/add-fbc-contribution/README.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ Task to create an internalrequest to add fbc contributions to index images
44

55
## Parameters
66

7-
| Name | Description | Optional | Default value |
8-
|---------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|-------------------------|
9-
| snapshotPath | Path to the JSON string of the mapped Snapshot spec in the data workspace | No | - |
10-
| dataPath | Path to the JSON string of the merged data to use in the data workspace | No | - |
11-
| fromIndex | fromIndex value updated by update-ocp-tag task | No | - |
12-
| pipelineRunUid | The uid of the current pipelineRun. Used as a label value when creating internal requests | No | - |
13-
| targetIndex | targetIndex value updated by update-ocp-tag task | No | - |
14-
| resultsDirPath | Path to results directory in the data workspace | No | - |
15-
| ociStorage | The OCI repository where the Trusted Artifacts are stored | Yes | empty |
16-
| ociArtifactExpiresAfter | Expiration date for the trusted artifacts created in the OCI repository. An empty string means the artifacts do not expire | Yes | 1d |
17-
| trustedArtifactsDebug | Flag to enable debug logging in trusted artifacts. Set to a non-empty string to enable | Yes | "" |
18-
| orasOptions | oras options to pass to Trusted Artifacts calls | Yes | "" |
19-
| sourceDataArtifact | Location of trusted artifacts to be used to populate data directory | Yes | "" |
20-
| dataDir | The location where data will be stored | Yes | $(workspaces.data.path) |
21-
| taskGitUrl | The url to the git repo where the release-service-catalog tasks and stepactions to be used are stored | No | "" |
22-
| taskGitRevision | The revision in the taskGitUrl repo to be used | No | "" |
7+
| Name | Description | Optional | Default value |
8+
|-------------------------|----------------------------------------------------------------------------------------------------------------------------|----------|-------------------------|
9+
| snapshotPath | Path to the JSON string of the mapped Snapshot spec in the data workspace | No | - |
10+
| dataPath | Path to the JSON string of the merged data to use in the data workspace | No | - |
11+
| fromIndex | fromIndex value updated by update-ocp-tag task | No | - |
12+
| targetIndex | targetIndex value updated by update-ocp-tag task | No | - |
13+
| pipelineRunUid | The uid of the current pipelineRun. Used as a label value when creating internal requests | No | - |
14+
| resultsDirPath | Path to the results directory in the data workspace | No | - |
15+
| ociStorage | The OCI repository where the Trusted Artifacts are stored | Yes | empty |
16+
| ociArtifactExpiresAfter | Expiration date for the trusted artifacts created in the OCI repository. An empty string means the artifacts do not expire | Yes | 1d |
17+
| trustedArtifactsDebug | Flag to enable debug logging in trusted artifacts. Set to a non-empty string to enable | Yes | "" |
18+
| orasOptions | oras options to pass to Trusted Artifacts calls | Yes | "" |
19+
| sourceDataArtifact | Location of trusted artifacts to be used to populate data directory | Yes | "" |
20+
| dataDir | The location where data will be stored | Yes | $(workspaces.data.path) |
21+
| taskGitUrl | The url to the git repo where the release-service-catalog tasks and stepactions to be used are stored | No | - |
22+
| taskGitRevision | The revision in the taskGitUrl repo to be used | No | - |

‎tasks/managed/add-fbc-contribution/add-fbc-contribution.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ metadata:
77
tekton.dev/pipelines.minVersion: "0.12.1"
88
tekton.dev/tags: release
99
spec:
10-
description: >-
11-
Task to create internalrequests to add contributions to index images
10+
description: |-
11+
Task to create an internalrequest to add fbc contributions to index images
1212
params:
1313
- name: snapshotPath
1414
description: Path to the JSON string of the mapped Snapshot spec in the data workspace
@@ -29,7 +29,7 @@ spec:
2929
type: string
3030
description: Path to the results directory in the data workspace
3131
- name: ociStorage
32-
description: The OCI repository where the Trusted Artifacts are stored.
32+
description: The OCI repository where the Trusted Artifacts are stored
3333
type: string
3434
default: "empty"
3535
- name: ociArtifactExpiresAfter
@@ -38,7 +38,7 @@ spec:
3838
type: string
3939
default: "1d"
4040
- name: trustedArtifactsDebug
41-
description: Flag to enable debug logging in trusted artifacts. Set to a non-empty string to enable.
41+
description: Flag to enable debug logging in trusted artifacts. Set to a non-empty string to enable
4242
type: string
4343
default: ""
4444
- name: orasOptions

‎tasks/managed/apply-mapping/README.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ A `mapped` result is also returned from this task containing a simple true/false
1212
meant to inform whether a mapped Snapshot is being returned or the original one.
1313

1414
This task supports variable expansion in tag values from the mapping. The currently supported variables are:
15-
* "{{ timestamp }}" -> The build-date label from the image in the format provided by timestampFormat or %s as the default.
15+
* "{{ timestamp }}" -> The build-date label from the image in the format provided by timestampFormat or %s as the
16+
default.
1617
If the build-date label is not available, we use the Created field in the image metadata as a fallback.
1718
* "{{ release_timestamp }}" -> The current time in the format provided by timestampFormat or %s as the default
1819
* "{{ git_sha }}" -> The git sha that triggered the snapshot being processed
@@ -29,12 +30,12 @@ You can also expand image labels, e.g. "{{ labels.mylabel }}" -> The value of im
2930
|-------------------------|----------------------------------------------------------------------------------------------------------------------------|----------|-------------------------|
3031
| snapshotPath | Path to the JSON string of the Snapshot spec in the config workspace to apply the mapping to | No | - |
3132
| dataPath | Path to the JSON string of the merged data to use in the data workspace | No | - |
32-
| failOnEmptyResult | Fail the task if the resulting snapshot contains zero components | Yes | false |
33+
| failOnEmptyResult | Fail the task if the resulting snapshot contains 0 components | Yes | false |
3334
| ociStorage | The OCI repository where the Trusted Artifacts are stored | Yes | empty |
3435
| ociArtifactExpiresAfter | Expiration date for the trusted artifacts created in the OCI repository. An empty string means the artifacts do not expire | Yes | 1d |
3536
| trustedArtifactsDebug | Flag to enable debug logging in trusted artifacts. Set to a non-empty string to enable | Yes | "" |
3637
| orasOptions | oras options to pass to Trusted Artifacts calls | Yes | "" |
3738
| sourceDataArtifact | Location of trusted artifacts to be used to populate data directory | Yes | "" |
3839
| dataDir | The location where data will be stored | Yes | $(workspaces.data.path) |
39-
| taskGitUrl | The url to the git repo where the release-service-catalog tasks and stepactions to be used are stored | No | "" |
40-
| taskGitRevision | The revision in the taskGitUrl repo to be used | No | "" |
40+
| taskGitUrl | The url to the git repo where the release-service-catalog tasks and stepactions to be used are stored | No | - |
41+
| taskGitRevision | The revision in the taskGitUrl repo to be used | No | - |

‎tasks/managed/apply-mapping/apply-mapping.yaml‎

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,30 @@ metadata:
77
tekton.dev/pipelines.minVersion: "0.12.1"
88
tekton.dev/tags: release
99
spec:
10-
description: >-
11-
Tekton task to apply a mapping to a Snapshot. It will override the Snapshot file.
10+
description: |-
11+
Tekton task to apply a mapping to a Snapshot.
12+
13+
The purpose of this task is to merge a mapping with the components contained in a Snapshot.
14+
The mapping is expected to be present in the data field of the ReleasePlanAdmission provided in
15+
the `releasePlanAdmissionPath`. If the data field does not contain a `mapping` key, the original
16+
Snapshot is returned. If there is a `mapping` key, it is merged with the `components` key in the
17+
Snapshot based on component name.
18+
19+
A `mapped` result is also returned from this task containing a simple true/false value that is
20+
meant to inform whether a mapped Snapshot is being returned or the original one.
21+
22+
This task supports variable expansion in tag values from the mapping. The currently supported variables are:
23+
* "{{ timestamp }}" -> The build-date label from the image in the format provided by timestampFormat or %s as the
24+
default.
25+
If the build-date label is not available, we use the Created field in the image metadata as a fallback.
26+
* "{{ release_timestamp }}" -> The current time in the format provided by timestampFormat or %s as the default
27+
* "{{ git_sha }}" -> The git sha that triggered the snapshot being processed
28+
* "{{ git_short_sha }}" -> The git sha reduced to 7 characters
29+
* "{{ digest_sha }}" -> The image digest of the respective component
30+
* "{{ incrementer }}" -> Automatically finds the highest existing incremented tag in the
31+
repository and generates the next sequential tag (e.g., if the highest tag is v1.0.0-2, it will generate v1.0.0-3)
32+
33+
You can also expand image labels, e.g. "{{ labels.mylabel }}" -> The value of image label "mylabel"
1234
params:
1335
- name: snapshotPath
1436
type: string
@@ -21,7 +43,7 @@ spec:
2143
description: Fail the task if the resulting snapshot contains 0 components
2244
default: "false"
2345
- name: ociStorage
24-
description: The OCI repository where the Trusted Artifacts are stored.
46+
description: The OCI repository where the Trusted Artifacts are stored
2547
type: string
2648
default: "empty"
2749
- name: ociArtifactExpiresAfter
@@ -30,7 +52,7 @@ spec:
3052
type: string
3153
default: "1d"
3254
- name: trustedArtifactsDebug
33-
description: Flag to enable debug logging in trusted artifacts. Set to a non-empty string to enable.
55+
description: Flag to enable debug logging in trusted artifacts. Set to a non-empty string to enable
3456
type: string
3557
default: ""
3658
- name: orasOptions

‎tasks/managed/base64-encode-checksum/README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ It returns as a result the blob to sign, that is the result of the base64 encode
66

77
## Parameters
88

9-
| Name | Description | Optional | Default value |
10-
|-------------------------|----------------------------------------------------------------------------------------------------------------------------|-----------|--------------------------|
11-
| binaries_dir | Path inside the image where the binaries to extract are stored | Yes | "binaries" |
12-
| ociStorage | The OCI repository where the Trusted Artifacts are stored | Yes | empty |
13-
| ociArtifactExpiresAfter | Expiration date for the trusted artifacts created in the OCI repository. An empty string means the artifacts do not expire | Yes | 1d |
14-
| trustedArtifactsDebug | Flag to enable debug logging in trusted artifacts. Set to a non-empty string to enable | Yes | "" |
15-
| orasOptions | oras options to pass to Trusted Artifacts calls | Yes | "" |
16-
| sourceDataArtifact | Location of trusted artifacts to be used to populate data directory | Yes | "" |
17-
| dataDir | The location where data will be stored | Yes | $(workspaces.data.path) |
18-
| taskGitUrl | The url to the git repo where the release-service-catalog tasks and stepactions to be used are stored | No | "" |
19-
| taskGitRevision | The revision in the taskGitUrl repo to be used | No | "" |
9+
| Name | Description | Optional | Default value |
10+
|-------------------------|----------------------------------------------------------------------------------------------------------------------------|----------|-------------------------|
11+
| binaries_dir | Path where the binaries are stored in the workspace | Yes | binaries |
12+
| ociStorage | The OCI repository where the Trusted Artifacts are stored | Yes | empty |
13+
| ociArtifactExpiresAfter | Expiration date for the trusted artifacts created in the OCI repository. An empty string means the artifacts do not expire | Yes | 1d |
14+
| trustedArtifactsDebug | Flag to enable debug logging in trusted artifacts. Set to a non-empty string to enable | Yes | "" |
15+
| orasOptions | oras options to pass to Trusted Artifacts calls | Yes | "" |
16+
| sourceDataArtifact | Location of trusted artifacts to be used to populate data directory | Yes | "" |
17+
| dataDir | The location where data will be stored | Yes | $(workspaces.data.path) |
18+
| taskGitUrl | The url to the git repo where the release-service-catalog tasks and stepactions to be used are stored | No | - |
19+
| taskGitRevision | The revision in the taskGitUrl repo to be used | No | - |

‎tasks/managed/base64-encode-checksum/base64-encode-checksum.yaml‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,17 @@ metadata:
77
tekton.dev/pipelines.minVersion: "0.12.1"
88
tekton.dev/tags: release
99
spec:
10-
description: >-
11-
Task to encode the Terraform Checksum file
10+
description: |-
11+
Task to encode the Terraform Checksum file.
12+
13+
It returns as a result the blob to sign, that is the result of the base64 encoded checksum
1214
params:
1315
- name: binaries_dir
1416
type: string
1517
description: Path where the binaries are stored in the workspace
1618
default: "binaries"
1719
- name: ociStorage
18-
description: The OCI repository where the Trusted Artifacts are stored.
20+
description: The OCI repository where the Trusted Artifacts are stored
1921
type: string
2022
default: "empty"
2123
- name: ociArtifactExpiresAfter
@@ -24,7 +26,7 @@ spec:
2426
type: string
2527
default: "1d"
2628
- name: trustedArtifactsDebug
27-
description: Flag to enable debug logging in trusted artifacts. Set to a non-empty string to enable.
29+
description: Flag to enable debug logging in trusted artifacts. Set to a non-empty string to enable
2830
type: string
2931
default: ""
3032
- name: orasOptions

0 commit comments

Comments
 (0)