Skip to content

Commit 2a86f32

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

27 files changed

Lines changed: 177 additions & 158 deletions

File tree

‎tasks/collectors/collect-collectors-resources/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ A task result is returned for each resource with the relative path to the stored
1212

1313
| Name | Description | Optional | Default value |
1414
|------------------------|------------------------------------------------------------------|----------|---------------|
15-
| previousRelease | Namespaced name of the previous Release | No | - |
16-
| release | Namespaced name of the Release | No | - |
17-
| collectorsResourceType | The type of resource that contains the collectors | No | - |
15+
| previousRelease | The namespaced name of the previous Release | No | - |
16+
| release | The namespaced name of the Release | No | - |
17+
| collectorsResourceType | The type of resource that contains the collectors | Yes | releaseplan |
1818
| collectorsResource | The namespaced name of the resource that contains the collectors | No | - |
1919
| subdirectory | Subdirectory inside the workspace to be used | Yes | "" |

‎tasks/collectors/collect-collectors-resources/collect-collectors-resources.yaml‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,14 @@ metadata:
77
tekton.dev/pipelines.minVersion: "0.12.1"
88
tekton.dev/tags: release
99
spec:
10-
description: Tekton task to collect the information related to collectors
10+
description: |-
11+
Tekton task to collect collectors related resources.
12+
13+
The purpose of this task is to collect all the resources related with the collectors feature and supply
14+
them to other tasks in the pipeline by creating json files for each resource. This task is similar
15+
to collect-data but it only collects a subset of the resources. Specifically those related to collectors.
16+
17+
A task result is returned for each resource with the relative path to the stored JSON for it in the workspace.
1118
params:
1219
- name: previousRelease
1320
type: string

‎tasks/collectors/run-collectors/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# run-collectors
22

3-
Tekton task to run the collectors defined in a resource passed as parameter. The results are saved in the resultsDir,
4-
one file per collector.
3+
Tekton task to run the collectors defined in a resource passed as parameter. The results are saved in the
4+
resultsDir, one file per collector.
55

66
## Parameters
77

@@ -12,5 +12,5 @@ one file per collector.
1212
| resultsDir | The relative path in the workspace to save the collector results to | No | - |
1313
| collectorsRepository | Git repository where the collectors will be defined | No | - |
1414
| collectorsRepositoryRevision | Git repository revision | Yes | main |
15-
| releasePath | Path to the json data file of the current in-progress Release | No | - |
15+
| releasePath | Path to the json data file of the current in-progress Release | No | - |
1616
| previousReleasePath | Path to the json data file of the previous successful Release prior to the current one | No | - |

‎tasks/collectors/run-collectors/run-collectors.yaml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ metadata:
77
tekton.dev/pipelines.minVersion: "0.12.1"
88
tekton.dev/tags: release
99
spec:
10-
description: >-
11-
Tekton task to run collectors defined in a resource passed as parameter
10+
description: |-
11+
Tekton task to run the collectors defined in a resource passed as parameter. The results are saved in the
12+
resultsDir, one file per collector.
1213
params:
1314
- name: collectorsPath
1415
type: string

‎tasks/collectors/save-collectors-results/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ A tekton task that updates the passed CR status with the contents stored in the
44

55
## Parameters
66

7-
| Name | Description | Optional | Default value |
8-
|----------------|----------------------------------------------------------------------------------------------------------------------|----------|---------------|
9-
| resourceType | The type of resource that is being patched | Yes | release |
10-
| statusKey | The top level key to overwrite in the resource status | Yes | collectors |
11-
| resource | The namespaced name of the resource to be patched | No | - |
12-
| resultsDirPath | Path to the directory containing the result files in the data workspace which will be added to the resource's status | No | - |
7+
| Name | Description | Optional | Default value |
8+
|----------------|------------------------------------------------------------------------------|----------|---------------|
9+
| resourceType | The type of resource that is being patched | Yes | release |
10+
| statusKey | The top level key to overwrite in the resource status | Yes | collectors |
11+
| resource | The namespaced name of the resource to be patched | No | - |
12+
| resultsDirPath | The relative path in the workspace where the collectors results are saved to | No | - |

‎tasks/collectors/save-collectors-results/save-collectors-results.yaml‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ metadata:
77
tekton.dev/pipelines.minVersion: "0.12.1"
88
tekton.dev/tags: release
99
spec:
10-
description: >-
11-
Tekton task to update the passed CR status with the
12-
collectors results.
10+
description: |-
11+
A tekton task that updates the passed CR status with the contents stored in the files in the resultsDir.
1312
params:
1413
- name: resourceType
1514
description: The type of resource that is being patched

‎tasks/internal/check-embargoed-cves-task/README.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# check-embargoed-cves-task
22

3-
Checks if any passed CVEs are embargoed. The task will always exit 0 even if something fails. This is because the task result
4-
will not be set if the task fails, and the task result should always be set and propagated back to the cluster that creates the
5-
internal request. The success/failure is handled in the task creating the internal request.
3+
Checks if any passed CVEs are embargoed.
4+
The task will always exit 0 even if something fails. This is because the task result will not be
5+
set if the task fails, and the task result should always be set and propagated back to the cluster
6+
that creates the internal request. The success/failure is handled in the task creating the internal
7+
request.
68

79
## Parameters
810

‎tasks/internal/collect-simple-signing-params/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ Task to collect parameters for the simple signing pipeline
44

55
## Parameters
66

7-
| Name | Description | Optional | Default value |
8-
|------------------|---------------------------------------------------------------------------------------|----------|--------------------------------------------------------|
9-
| config_map_name | Name of a configmap with pipeline configuration | No | - |
7+
| Name | Description | Optional | Default value |
8+
|-----------------|-------------------------------------------------|----------|---------------|
9+
| config_map_name | Name of a configmap with pipeline configuration | No | - |

‎tasks/internal/collect-simple-signing-params/collect-simple-signing-params.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ metadata:
66
annotations:
77
tekton.dev/tags: release
88
spec:
9+
description: |-
10+
Task to collect parameters for the simple signing pipeline
911
params:
1012
- name: config_map_name
1113
description: Name of a configmap with pipeline configuration

‎tasks/internal/create-advisory-oci-artifact-task/README.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# create-advisory-oci-artifact-task
22

33
Creates an oci artifact of an advisory given a Gitlab URL.
4+
The task will always exit 0 even if something fails. This is because the task result will not be
5+
set if the task fails, and the task result should always be set and propagated back to the cluster
6+
that creates the internal request. The success/failure is handled in the task creating the internal
7+
request.
48

59
## Parameters
610

7-
| Name | Description | Optional | Default value |
8-
|-------------------------------------------------|----------------------------------------------------------------------------------------------------|----------|-------------------------------------------------------|
9-
| advisory_url | the url of the advisory | No | - |
10-
| internalRequestPipelineRunName | Name of the PipelineRun that called this task | No | - |
11-
| trusted_artifacts_dockerconfig_json_secret_name | The name of the secret that contains to dockerconfig json to use for trusted artifact operations | Yes | quay-token-konflux-release-trusted-artifacts-secret |
11+
| Name | Description | Optional | Default value |
12+
|-------------------------------------------------|--------------------------------------------------------------------------------------------------|----------|-----------------------------------------------------|
13+
| advisory_url | the url of the advisory | No | - |
14+
| internalRequestPipelineRunName | Name of the PipelineRun that called this task | No | - |
15+
| trusted_artifacts_dockerconfig_json_secret_name | The name of the secret that contains to dockerconfig json to use for trusted artifact operations | Yes | quay-token-konflux-release-trusted-artifacts-secret |

0 commit comments

Comments
 (0)