chore(RHTAPREL-667): remove all CR default values from tasks (#396)

This commit removes default CR snapshotPath and dataPath values from tasks. Signed-off-by: Leandro Mendes <[email protected]>
konflux-ci · May 1, 2024 · 48e97ec · 48e97ec
1 parent 9f91792
commit 48e97ec
Show file tree

Hide file tree

Showing 95 changed files with 311 additions and 99 deletions.
diff --git a/tasks/add-fbc-contribution/README.md b/tasks/add-fbc-contribution/README.md
@@ -6,13 +6,16 @@ Task to create a internalrequest to add fbc contributions to index images
 
 | Name           | Description                                                                               | Optional | Default value        |
 |----------------|-------------------------------------------------------------------------------------------|----------|----------------------|
-| snapshotPath   | Path to the JSON string of the mapped Snapshot spec in the data workspace                 | Yes      | snapshot_spec.json   |
-| dataPath       | Path to the JSON string of the merged data to use in the data workspace                   | Yes      | data.json            |
+| snapshotPath   | Path to the JSON string of the mapped Snapshot spec in the data workspace                 | No       |                      |
+| dataPath       | Path to the JSON string of the merged data to use in the data workspace                   | No       |                      |
 | binaryImage    | binaryImage value updated by update-ocp-tag task                                          | No       |                      |
 | fromIndex      | fromIndex value updated by update-ocp-tag task                                            | No       |                      |
 | pipelineRunUid | The uid of the current pipelineRun. Used as a label value when creating internal requests | No       |                      |
 | targetIndex    | targetIndex value updated by update-ocp-tag task                                          | No       |                      |
 
+## changes in 2.4.0
+- remove default values of `dataPath` and `snapshotPath` parameters
+
 ## changes in 2.3.2
 - add check to fail the task if `fbc.preGA` and `fbc.hotfix` were both set in the `ReleasePlanAdmission` data and
   test for the failing scenario

diff --git a/tasks/add-fbc-contribution/add-fbc-contribution.yaml b/tasks/add-fbc-contribution/add-fbc-contribution.yaml
@@ -4,7 +4,7 @@ kind: Task
 metadata:
   name: add-fbc-contribution
   labels:
-    app.kubernetes.io/version: "2.3.2"
+    app.kubernetes.io/version: "2.4.0"
   annotations:
     tekton.dev/pipelines.minVersion: "0.12.1"
     tekton.dev/tags: release
@@ -15,11 +15,9 @@ spec:
     - name: snapshotPath
       description: Path to the JSON string of the mapped Snapshot spec in the data workspace
       type: string
-      default: "snapshot_spec.json"
     - name: dataPath
       description: Path to the JSON string of the merged data to use in the data workspace
       type: string
-      default: "data.json"
     - name: binaryImage
       type: string
       description: binaryImage value updated by update-ocp-tag task

diff --git a/tasks/add-fbc-contribution/tests/test-add-fbc-contribution-hotfix.yaml b/tasks/add-fbc-contribution/tests/test-add-fbc-contribution-hotfix.yaml
@@ -59,6 +59,10 @@ spec:
           value: "quay.io/scoheb/fbc-target-index-testing:v4.12"
         - name: pipelineRunUid
           value: $(context.pipelineRun.uid)
+        - name: snapshotPath
+          value: snapshot_spec.json
+        - name: dataPath
+          value: data.json
       workspaces:
         - name: data
           workspace: tests-workspace

diff --git a/tasks/add-fbc-contribution/tests/test-add-fbc-contribution-pre-ga-and-hotfix-failure.yaml b/tasks/add-fbc-contribution/tests/test-add-fbc-contribution-pre-ga-and-hotfix-failure.yaml
@@ -64,6 +64,10 @@ spec:
           value: "quay.io/scoheb/fbc-target-index-testing:v4.12"
         - name: pipelineRunUid
           value: $(context.pipelineRun.uid)
+        - name: dataPath
+          value: data.json
+        - name: snapshotPath
+          value: snapshot_spec.json
       workspaces:
         - name: data
           workspace: tests-workspace

diff --git a/tasks/add-fbc-contribution/tests/test-add-fbc-contribution-pre-ga.yaml b/tasks/add-fbc-contribution/tests/test-add-fbc-contribution-pre-ga.yaml
@@ -61,6 +61,10 @@ spec:
           value: "quay.io/scoheb/fbc-target-index-testing:v4.12"
         - name: pipelineRunUid
           value: $(context.pipelineRun.uid)
+        - name: snapshotPath
+          value: snapshot_spec.json
+        - name: dataPath
+          value: data.json
       workspaces:
         - name: data
           workspace: tests-workspace

diff --git a/tasks/add-fbc-contribution/tests/test-add-fbc-contribution-staged-index.yaml b/tasks/add-fbc-contribution/tests/test-add-fbc-contribution-staged-index.yaml
@@ -56,6 +56,10 @@ spec:
           value: "quay.io/scoheb/fbc-index-testing:v4.12"
         - name: pipelineRunUid
           value: $(context.pipelineRun.uid)
+        - name: snapshotPath
+          value: snapshot_spec.json
+        - name: dataPath
+          value: data.json
       workspaces:
         - name: data
           workspace: tests-workspace

diff --git a/tasks/add-fbc-contribution/tests/test-add-fbc-contribution-timeout.yaml b/tasks/add-fbc-contribution/tests/test-add-fbc-contribution-timeout.yaml
@@ -58,6 +58,10 @@ spec:
           value: "quay.io/scoheb/fbc-target-index-testing:v4.12"
         - name: pipelineRunUid
           value: $(context.pipelineRun.uid)
+        - name: snapshotPath
+          value: snapshot_spec.json
+        - name: dataPath
+          value: data.json
       workspaces:
         - name: data
           workspace: tests-workspace

diff --git a/tasks/add-fbc-contribution/tests/test-add-fbc-contribution.yaml b/tasks/add-fbc-contribution/tests/test-add-fbc-contribution.yaml
@@ -58,6 +58,10 @@ spec:
           value: "quay.io/scoheb/fbc-target-index-testing:v4.12"
         - name: pipelineRunUid
           value: $(context.pipelineRun.uid)
+        - name: snapshotPath
+          value: snapshot_spec.json
+        - name: dataPath
+          value: data.json
       workspaces:
         - name: data
           workspace: tests-workspace

diff --git a/tasks/apply-mapping/README.md b/tasks/apply-mapping/README.md
@@ -15,10 +15,13 @@ meant to inform whether a mapped Snapshot is being returned or the original one.
 
 | Name | Description | Optional | Default value |
 |------|-------------|----------|---------------|
-| snapshotPath | Path to the JSON string of the Snapshot spec in the config workspace to apply the mapping to | Yes | snapshot_spec.json |
-| releasePlanAdmissionPath | Path to the JSON string of the ReleasePlanAdmission in the config workspace which contains the mapping to apply | Yes | release_plan_admission.json |
+| snapshotPath | Path to the JSON string of the Snapshot spec in the config workspace to apply the mapping to | No | |
+| releasePlanAdmissionPath | Path to the JSON string of the ReleasePlanAdmission in the config workspace which contains the mapping to apply | No | |
 | failOnEmptyResult | Fail the task if the resulting snapshot contains zero components | Yes | false |
 
+## Changes in 0.10.0
+ * Removed default values for `snapshotPath` and `releasePlanAdmissionPath`
+
 ## Changes in 0.9.1
   * Replaced `echo` with `printf` for storing results.
     Using `echo` resulted in appending `true\n` to the output,

diff --git a/tasks/apply-mapping/apply-mapping.yaml b/tasks/apply-mapping/apply-mapping.yaml
@@ -4,7 +4,7 @@ kind: Task
 metadata:
   name: apply-mapping
   labels:
-    app.kubernetes.io/version: "0.9.1"
+    app.kubernetes.io/version: "0.10.0"
   annotations:
     tekton.dev/pipelines.minVersion: "0.12.1"
     tekton.dev/tags: release
@@ -15,13 +15,11 @@ spec:
     - name: snapshotPath
       type: string
       description: Path to the JSON string of the Snapshot spec in the config workspace to apply the mapping to
-      default: "snapshot_spec.json"
     - name: releasePlanAdmissionPath
       type: string
       description: |
         Path to the JSON string of the ReleasePlanAdmission in the
         config workspace which contains the mapping to apply
-      default: "release_plan_admission.json"
     - name: failOnEmptyResult
       type: string
       description: Fail the task if the resulting snapshot contains 0 components

diff --git a/tasks/apply-mapping/tests/test-apply-mapping-no-rpa.yaml b/tasks/apply-mapping/tests/test-apply-mapping-no-rpa.yaml
@@ -54,6 +54,11 @@ spec:
     - name: run-task
       taskRef:
         name: apply-mapping
+      params:
+        - name: snapshotPath
+          value: snapshot_spec.json
+        - name: releasePlanAdmissionPath
+          value: ""
       workspaces:
         - name: config
           workspace: tests-workspace

diff --git a/tasks/check-data-keys/README.md b/tasks/check-data-keys/README.md
@@ -12,9 +12,12 @@ Currently, `releaseNotes` is the only supported system.
 
 | Name     | Description                                             | Optional | Default value |
 |----------|---------------------------------------------------------|----------|---------------|
-| dataPath | Path to the JSON string of the merged data to use       | Yes      | data.json     |
+| dataPath | Path to the JSON string of the merged data to use       | No       |               |
 | systems  | The systems to check that all data keys are present for | Yes      | []            |
 
+## Changes in 0.6.0
+- Remove `dataPath` default value
+
 ## Changes in 0.5.0
 - Add releaseNotes.product_stream to required keys
 

diff --git a/tasks/check-data-keys/check-data-keys.yaml b/tasks/check-data-keys/check-data-keys.yaml
@@ -4,7 +4,7 @@ kind: Task
 metadata:
   name: check-data-keys
   labels:
-    app.kubernetes.io/version: "0.5.0"
+    app.kubernetes.io/version: "0.6.0"
   annotations:
     tekton.dev/pipelines.minVersion: "0.12.1"
     tekton.dev/tags: release
@@ -15,7 +15,6 @@ spec:
     - name: dataPath
       description: Path to the JSON string of the merged data to use
       type: string
-      default: "data.json"
     - name: systems
       description: The systems to check that all data keys are present for
       type: array

diff --git a/tasks/check-fbc-packages/README.md b/tasks/check-fbc-packages/README.md
@@ -4,7 +4,10 @@ Task to check that the packages being shipped in an fbc contribution are in the
 
 ## Parameters
 
-| Name           | Description                                                               | Optional | Default value        |
-|----------------|---------------------------------------------------------------------------|----------|----------------------|
-| snapshotPath   | Path to the JSON string of the mapped Snapshot spec in the data workspace | Yes      | snapshot_spec.json   |
-| dataPath       | Path to the JSON string of the merged data to use in the data workspace   | Yes      | data.json            |
+| Name           | Description                                                               | Optional | Default value |
+|----------------|---------------------------------------------------------------------------|----------|---------------|
+| snapshotPath   | Path to the JSON string of the mapped Snapshot spec in the data workspace | No       |               |
+| dataPath       | Path to the JSON string of the merged data to use in the data workspace   | No       |               |
+
+## changes in 0.2.0
+- remove default values of `snapshotPath` and `dataPath` parameters
diff --git a/tasks/check-fbc-packages/check-fbc-packages.yaml b/tasks/check-fbc-packages/check-fbc-packages.yaml
@@ -4,7 +4,7 @@ kind: Task
 metadata:
   name: check-fbc-packages
   labels:
-    app.kubernetes.io/version: "0.1.0"
+    app.kubernetes.io/version: "0.2.0"
   annotations:
     tekton.dev/pipelines.minVersion: "0.12.1"
     tekton.dev/tags: release
@@ -15,11 +15,9 @@ spec:
     - name: snapshotPath
       description: Path to the JSON string of the mapped Snapshot spec in the data workspace
       type: string
-      default: "snapshot_spec.json"
     - name: dataPath
       description: Path to the JSON string of the merged data to use in the data workspace
       type: string
-      default: "data.json"
   workspaces:
     - name: data
       description: workspace to read and save files

diff --git a/tasks/check-fbc-packages/tests/test-check-fbc-packages-negative.yaml b/tasks/check-fbc-packages/tests/test-check-fbc-packages-negative.yaml
@@ -47,6 +47,11 @@ spec:
     - name: run-task
       taskRef:
         name: check-fbc-packages
+      params:
+        - name: snapshotPath
+          value: snapshot_spec.json
+        - name: dataPath
+          value: data.json
       workspaces:
         - name: data
           workspace: tests-workspace

diff --git a/tasks/check-fbc-packages/tests/test-check-fbc-packages-positive.yaml b/tasks/check-fbc-packages/tests/test-check-fbc-packages-positive.yaml
@@ -45,6 +45,11 @@ spec:
     - name: run-task
       taskRef:
         name: check-fbc-packages
+      params:
+        - name: snapshotPath
+          value: snapshot_spec.json
+        - name: dataPath
+          value: data.json
       workspaces:
         - name: data
           workspace: tests-workspace

diff --git a/tasks/collect-gh-params/README.md b/tasks/collect-gh-params/README.md
@@ -6,6 +6,9 @@ Tekton task that collects the three parameters to pass to the `create-github-rel
 
 | Name | Description | Optional | Default value |
 |------|-------------|----------|---------------|
-| dataPath | Path to the merged data JSON file generated by collect-data task | Yes | data.json |
-| snapshotPath | Path to the Snapshot file | Yes | mapped_snapshot.json |
+| dataPath | Path to the merged data JSON file generated by collect-data task | No | |
+| snapshotPath | Path to the Snapshot file | No | |
 | binariesPath | Path to the binaries directory to release | Yes | binaries |
+
+## Changes in 1.1.0
+- Removes `dataPath` and `snapshotPath` default values
diff --git a/tasks/collect-gh-params/collect-gh-params.yaml b/tasks/collect-gh-params/collect-gh-params.yaml
@@ -4,7 +4,7 @@ kind: Task
 metadata:
   name: collect-gh-params
   labels:
-    app.kubernetes.io/version: "1.0.0"
+    app.kubernetes.io/version: "1.1.0"
   annotations:
     tekton.dev/pipelines.minVersion: "0.12.1"
     tekton.dev/tags: release
@@ -15,11 +15,9 @@ spec:
     - name: dataPath
       type: string
       description: Path to the JSON string of the merged data containing the pyxis configuration options to use
-      default: data.json
     - name: snapshotPath
       type: string
       description: Path to the JSON string of the mapped Snapshot spec in the data workspace
-      default: mapped_snapshot.json
     - name: binariesPath
       description: Path to the binaries directory to release
       type: string

diff --git a/tasks/collect-pyxis-params/README.md b/tasks/collect-pyxis-params/README.md
@@ -8,7 +8,10 @@ for downstream tasks to use.
 
 | Name | Description | Optional | Default value |
 |------|-------------|----------|---------------|
-| dataPath | Path to the merged data JSON file generated by collect-data task and containing the pyxis configuration options to use | Yes | data.json |
+| dataPath | Path to the merged data JSON file generated by collect-data task and containing the pyxis configuration options to use | No | |
+
+## Changes in 0.3.0
+* Remove `dataPath` default value
 
 ## Changes in 0.2.1
 * Update the description for `server` result

diff --git a/tasks/collect-pyxis-params/collect-pyxis-params.yaml b/tasks/collect-pyxis-params/collect-pyxis-params.yaml
@@ -4,7 +4,7 @@ kind: Task
 metadata:
   name: collect-pyxis-params
   labels:
-    app.kubernetes.io/version: "0.2.1"
+    app.kubernetes.io/version: "0.3.0"
   annotations:
     tekton.dev/pipelines.minVersion: "0.12.1"
     tekton.dev/tags: release
@@ -15,7 +15,6 @@ spec:
     - name: dataPath
       type: string
       description: Path to the JSON string of the merged data containing the pyxis configuration options to use
-      default: data.json
   workspaces:
     - name: data
       description: The workspace where the snapshot spec json file resides

diff --git a/tasks/collect-slack-notification-params/README.md b/tasks/collect-slack-notification-params/README.md
@@ -8,9 +8,12 @@ as a task result for downstream tasks to use.
 | Name                 | Description                                                                                                  | Optional | Default value                                                      |
 |----------------------|--------------------------------------------------------------------------------------------------------------|----------|--------------------------------------------------------------------|
 | releasePath          | Path to the JSON string of the Release CR                                                                    | No       | -                                                                  |
-| snapshotPath         | Path to the JSON string of the mapped Snapshot spec in the data workspace                                    | Yes      | snapshot_spec.json                                                 |
-| dataPath             | Path to the merged data JSON file generated by collect-data task and containing configuration options to use | Yes      | data.json                                                          |
+| snapshotPath         | Path to the JSON string of the mapped Snapshot spec in the data workspace                                    | No       |                                                                    |
+| dataPath             | Path to the merged data JSON file generated by collect-data task and containing configuration options to use | No       |                                                                    |
 | hacUrl               | Root URL of HAC UI (hybrid access console)                                                                   | Yes      | https://console.redhat.com/preview/application-pipeline/workspaces | 
 
+## Changes in 1.2.0
+* remove `dataPath` and `snapshotPath` default values
+
 ## Changes in 1.1.0
 * Updated hacbs-release/release-utils image to reference redhat-appstudio/release-service-utils image instead
diff --git a/tasks/collect-slack-notification-params/collect-slack-notification-params.yaml b/tasks/collect-slack-notification-params/collect-slack-notification-params.yaml
@@ -4,7 +4,7 @@ kind: Task
 metadata:
   name: collect-slack-notification-params
   labels:
-    app.kubernetes.io/version: "1.1.0"
+    app.kubernetes.io/version: "1.2.0"
   annotations:
     tekton.dev/pipelines.minVersion: "0.12.1"
     tekton.dev/tags: release
@@ -19,11 +19,9 @@ spec:
     - name: snapshotPath
       description: Path to the JSON string of the mapped Snapshot spec in the data workspace
       type: string
-      default: snapshot_spec.json
     - name: dataPath
       type: string
       description: Path to the JSON string of the merged data containing the configuration options to use
-      default: data.json
     - name: hacUrl
       type: string
       description: Root URL of HAC UI (hybrid access console)

diff --git a/tasks/create-advisory/README.md b/tasks/create-advisory/README.md
@@ -10,14 +10,17 @@ Only all `redhat-pending` or all `redhat-prod` repositories may be specified in
 | Name                     | Description                                                                               | Optional | Default value               |
 |--------------------------|-------------------------------------------------------------------------------------------|----------|-----------------------------|
 | jsonKey                  | The json key containing the advisory data                                                 | Yes      | .releaseNotes               |
-| releasePlanAdmissionPath | Path to the JSON file of the ReleasePlanAdmission in the data workspace                   | Yes      | release_plan_admission.json |
+| releasePlanAdmissionPath | Path to the JSON file of the ReleasePlanAdmission in the data workspace                   | No       |                             |
 | releaseServiceConfigPath | Path to the JSON file of the ReleaseServiceConfig in the data workspace                   | No       |                             |
-| snapshotPath             | Path to the JSON file of the Snapshot spec in the data workspace                          | Yes      | snapshot_spec.json          |
-| dataPath                 | Path to data JSON in the data workspace                                                   | Yes      | data.json                   |
+| snapshotPath             | Path to the JSON file of the Snapshot spec in the data workspace                          | No       |                             |
+| dataPath                 | Path to data JSON in the data workspace                                                   | No       |                             |
 | request                  | Type of request to be created                                                             | Yes      | create-advisory             |
 | synchronously            | Whether the task should wait for InternalRequests to complete                             | Yes      | true                        |
 | pipelineRunUid           | The uid of the current pipelineRun. Used as a label value when creating internal requests | No       |                             |
 
+## Changes in 3.2.0
+- remove `dataPath`, `snapshotPath` and `releasePlanAdmissionPath` default values
+
 ## Changes in 3.1.0
 - This task now detects which secret to use for creating advisories based on the targeted quay repository.
 - Only all `redhat-pending` or all `redhat-prod` repositories may be specified in `.data.mapping`

diff --git a/tasks/create-advisory/create-advisory.yaml b/tasks/create-advisory/create-advisory.yaml
@@ -4,7 +4,7 @@ kind: Task
 metadata:
   name: create-advisory
   labels:
-    app.kubernetes.io/version: "3.1.0"
+    app.kubernetes.io/version: "3.2.0"
   annotations:
     tekton.dev/pipelines.minVersion: "0.12.1"
     tekton.dev/tags: release
@@ -19,18 +19,15 @@ spec:
     - name: releasePlanAdmissionPath
       type: string
       description: Path to the JSON string of the ReleasePlanAdmission in the data workspace
-      default: "release_plan_admission.json"
     - name: releaseServiceConfigPath
       type: string
       description: Path to the JSON string of the ReleaseServiceConfig in the data workspace
     - name: snapshotPath
       type: string
       description: Path to the JSON string of the Snapshot spec in the data workspace
-      default: "snapshot_spec.json"
     - name: dataPath
       type: string
       description: Path to the data JSON in the data workspace
-      default: "data.json"
     - name: request
       type: string
       description: Type of request to be created