Skip to content

Commit c1e0643

Browse files
author
Paul Fitzgerald
committed
feat(RELEASE-1675): auto generate README.md files for tasks/pipelines
Updated all README.md files in pipelines/ Signed-off-by: Paul Fitzgerald <pafitzge@redhat.com>
1 parent a1417a5 commit c1e0643

59 files changed

Lines changed: 288 additions & 254 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.

‎pipelines/internal/blob-signing-pipeline/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Tekton pipeline for signing base64 blobs
66

77
| Name | Description | Optional | Default value |
88
|-----------------|---------------------------------------------------------------------------------------|----------|---------------------------------------------------------------------------------------|
9-
| pipeline_image | An image with CLI tools needed for the signing. | Yes | quay.io/redhat-isv/operator-pipelines-images:9ea90b42456fcdf66edf4b15c0c0487ba5fa3ee3 |
10-
| blob | Blob that needs to be signed. | No | - |
9+
| pipeline_image | An image with CLI tools needed for the signing | Yes | quay.io/redhat-isv/operator-pipelines-images:9ea90b42456fcdf66edf4b15c0c0487ba5fa3ee3 |
10+
| blob | Blob that needs to be signed | No | - |
1111
| requester | Name of the user that requested the signing, for auditing purposes | No | - |
1212
| config_map_name | A config map name with configuration | Yes | hacbs-signing-pipeline-config |
1313
| taskGitUrl | The url to the git repo where the release-service-catalog tasks to be used are stored | Yes | https://github.com/konflux-ci/release-service-catalog.git |

‎pipelines/internal/blob-signing-pipeline/blob-signing-pipeline.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ metadata:
77
tekton.dev/pipelines.minVersion: "0.12.1"
88
tekton.dev/tags: release
99
spec:
10-
description: >-
11-
Tekton pipeline for simple signing
10+
description: |-
11+
Tekton pipeline for signing base64 blobs
1212
params:
1313
- name: pipeline_image
14-
description: An image with CLI tools needed for the signing.
14+
description: An image with CLI tools needed for the signing
1515
default: quay.io/redhat-isv/operator-pipelines-images:9ea90b42456fcdf66edf4b15c0c0487ba5fa3ee3
1616
- name: blob
17-
description: Blob that needs to be signed.
17+
description: Blob that needs to be signed
1818
- name: requester
1919
description: Name of the user that requested the signing, for auditing purposes
2020
type: string

‎pipelines/internal/check-embargoed-cves/check-embargoed-cves.yaml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ metadata:
77
tekton.dev/pipelines.minVersion: "0.12.1"
88
tekton.dev/tags: release
99
spec:
10-
description: >-
11-
Pipeline to check if any CVEs passed are embargoed
10+
description: |-
11+
Tekton pipeline to execute the check-embargoed-cves task. The goal of the task is to ensure none of the provided
12+
CVEs are marked as embargoed. If so, the pipeline result `result` will be the error and check `embargoed_cves`
13+
result will be the list of embargoed CVEs.
1214
params:
1315
- name: cves
1416
type: string

‎pipelines/internal/create-advisory-oci-artifact/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Pipeline to generate an oci artifact containing an advisory json using an adviso
44

55
## Parameters
66

7-
| Name | Description | Optional | Default value |
8-
|---------------------|-----------------------------------------------------------------------------------------|----------|-------------------------------------------------------------|
9-
| advisory_url | URL pointing to the advisory | No | - |
10-
| taskGitUrl | The url to the git repo where the release-service-catalog tasks to be used are stored | Yes | https://github.com/konflux-ci/release-service-catalog.git |
11-
| taskGitRevision | The revision in the taskGitUrl repo to be used | No | - |
7+
| Name | Description | Optional | Default value |
8+
|-----------------|---------------------------------------------------------------------------------------|----------|-----------------------------------------------------------|
9+
| advisory_url | advisory url | No | - |
10+
| taskGitUrl | The url to the git repo where the release-service-catalog tasks to be used are stored | Yes | https://github.com/konflux-ci/release-service-catalog.git |
11+
| taskGitRevision | The revision in the taskGitUrl repo to be used | No | - |

‎pipelines/internal/create-advisory-oci-artifact/create-advisory-oci-artifact.yaml‎

Lines changed: 2 additions & 2 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: advisory
99
spec:
10-
description: >-
11-
Pipeline to generate an oci artifact containing an advisory json using an advisory url.
10+
description: |-
11+
Pipeline to generate an oci artifact containing an advisory json using an advisory url.
1212
params:
1313
- name: advisory_url
1414
type: string

‎pipelines/internal/create-advisory/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ advisory URL as well as a result to show the error message if one occurred.
1111
| advisory_json | String containing a JSON representation of the advisory data (e.g. '{"product_id":123,"type":"RHSA"}') | No | - |
1212
| application | Application being released | No | - |
1313
| origin | The origin workspace where the release CR comes from. This is used to determine the advisory path | No | - |
14-
| contentType | The contentType of the release artifact. One of [image|binary|generic] | Yes | image |
1514
| config_map_name | The name of the configMap that contains the signing key | No | - |
15+
| contentType | The contentType of the release artifact. One of [image|binary|generic] | Yes | image |
1616
| advisory_secret_name | The name of the secret that contains the advisory creation metadata | No | - |
1717
| errata_secret_name | The name of the secret that contains the errata service account metadata | No | - |
1818
| taskGitUrl | The url to the git repo where the release-service-catalog tasks to be used are stored | Yes | https://github.com/konflux-ci/release-service-catalog.git |

‎pipelines/internal/create-advisory/create-advisory.yaml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ metadata:
77
tekton.dev/pipelines.minVersion: "0.12.1"
88
tekton.dev/tags: advisory
99
spec:
10-
description: >-
11-
Pipeline to push an advisory yaml to a Git repository
10+
description: |-
11+
Tekton pipeline to execute the create-advisory task. The task clones the advisory repo, gets an ID for the advisory,
12+
generates an advisory, then pushes it if the generated advisory is valid. The pipeline returns a result with the
13+
advisory URL as well as a result to show the error message if one occurred.
1214
params:
1315
- name: advisory_json
1416
type: string

‎pipelines/internal/filter-already-released-advisory-images/README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ This pipeline filters out images from a snapshot that have already been publishe
44

55
## Parameters
66

7-
| Name | Description | Optional | Default value |
8-
|----------------------|--------------------------------------------------------------------------------------------------------|----------|-----------------------------------------------------------|
9-
| snapshot_json | JSON string of the Snapshot spec containing the images to be filtered | No | - |
10-
| origin | The origin workspace where the release CR comes from. This is used to determine the advisory path | No | - |
11-
| advisory_secret_name | The name of the secret that contains the advisory creation metadata | No | - |
12-
| taskGitUrl | The url to the git repo where the release-service-catalog tasks to be used are stored | Yes | https://github.com/konflux-ci/release-service-catalog.git |
13-
| taskGitRevision | The revision in the taskGitUrl repo to be used | No | - |
7+
| Name | Description | Optional | Default value |
8+
|----------------------|---------------------------------------------------------------------------------------------------|----------|-----------------------------------------------------------|
9+
| snapshot | Base64 string of gzipped JSON representation of the snapshot spec | No | - |
10+
| origin | The origin workspace where the release CR comes from. This is used to determine the advisory path | No | - |
11+
| advisory_secret_name | The name of the secret that contains the advisory creation metadata | No | - |
12+
| taskGitUrl | The url to the git repo where the release-service-catalog tasks to be used are stored | Yes | https://github.com/konflux-ci/release-service-catalog.git |
13+
| taskGitRevision | The revision in the taskGitUrl repo to be used | No | - |

‎pipelines/internal/filter-already-released-advisory-images/filter-already-released-advisory-images.yaml‎

Lines changed: 2 additions & 2 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-
Pipeline to filter out already-released images from a snapshot
10+
description: |-
11+
This pipeline filters out images from a snapshot that have already been published in advisories.
1212
params:
1313
- name: snapshot
1414
type: string

‎pipelines/internal/get-advisory-severity/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ for an advisory.
55

66
## Parameters
77

8-
| Name | Description | Optional | Default value |
9-
|-------------------|---------------------------------------------------------------------------------------|----------|-----------------------------------------------------------|
10-
| releaseNoteImages | Json array of image specific details for the advisory | No | - |
11-
| taskGitUrl | The url to the git repo where the release-service-catalog tasks to be used are stored | Yes | https://github.com/konflux-ci/release-service-catalog.git |
12-
| taskGitRevision | The revision in the taskGitUrl repo to be used | No | - |
8+
| Name | Description | Optional | Default value |
9+
|--------------------|---------------------------------------------------------------------------------------|----------|-----------------------------------------------------------|
10+
| releaseNotesImages | Json array of image specific details for the advisory | No | - |
11+
| taskGitUrl | The url to the git repo where the release-service-catalog tasks to be used are stored | Yes | https://github.com/konflux-ci/release-service-catalog.git |
12+
| taskGitRevision | The revision in the taskGitUrl repo to be used | No | - |

0 commit comments

Comments
 (0)