Skip to content

remove deprecated TIMEOUT parameter from tasks#3100

Open
robnester-rh wants to merge 1 commit intoconforma:mainfrom
robnester-rh:EC-1425
Open

remove deprecated TIMEOUT parameter from tasks#3100
robnester-rh wants to merge 1 commit intoconforma:mainfrom
robnester-rh:EC-1425

Conversation

@robnester-rh
Copy link
Contributor

This commit removes the deprecated TIMEOUT task parameter from the following tasks:

  • verify-conforma-konflux-ta
  • verify-conforma-konflux-vsa-ta
  • verify-enterprise-contract

This commit also updates the associated documentation and README files.

Ref: EC-1425

This commit removes the deprecated TIMEOUT task parameter from the
following tasks:

- `verify-conforma-konflux-ta`
- `verify-conforma-konflux-vsa-ta`
- `verify-enterprise-contract`

This commit also updates the associated documentation and README files.

Ref: EC-1425
Signed-off-by: Rob Nester <rnester@redhat.com>
@qodo-code-review
Copy link
Contributor

Review Summary by Qodo

Remove deprecated TIMEOUT parameter from Tekton tasks

✨ Enhancement

Grey Divider

Walkthroughs

Description
• Remove deprecated TIMEOUT parameter from three Tekton tasks
• Update task YAML definitions to remove parameter declaration
• Update documentation and README files accordingly
Diagram
flowchart LR
  A["Three Tekton Tasks"] -->|Remove TIMEOUT param| B["Task YAML Files"]
  A -->|Remove TIMEOUT docs| C["Documentation Files"]
  B --> D["Updated Task Definitions"]
  C --> E["Updated Documentation"]
Loading

Grey Divider

File Changes

1. tasks/verify-conforma-konflux-ta/0.1/verify-conforma-konflux-ta.yaml ✨ Enhancement +0/-7

Remove TIMEOUT parameter from task definition

• Removed TIMEOUT parameter definition from task spec
• Removed parameter description and default value
• Cleaned up parameter list formatting

tasks/verify-conforma-konflux-ta/0.1/verify-conforma-konflux-ta.yaml


2. tasks/verify-conforma-konflux-vsa-ta/0.1/verify-conforma-konflux-vsa-ta.yaml ✨ Enhancement +0/-7

Remove TIMEOUT parameter from VSA task

• Removed deprecated TIMEOUT parameter from task spec
• Removed parameter description and default value
• Maintained parameter list structure

tasks/verify-conforma-konflux-vsa-ta/0.1/verify-conforma-konflux-vsa-ta.yaml


3. tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml ✨ Enhancement +0/-7

Remove TIMEOUT parameter from EC task

• Removed TIMEOUT parameter definition from task spec
• Removed parameter description and default value
• Cleaned up parameter list formatting

tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml


View more (5)
4. tasks/verify-conforma-konflux-ta/0.1/README.md 📝 Documentation +0/-1

Remove TIMEOUT parameter documentation

• Removed TIMEOUT parameter documentation from README
• Removed deprecation notice and usage guidance

tasks/verify-conforma-konflux-ta/0.1/README.md


5. tasks/verify-enterprise-contract/0.1/README.md 📝 Documentation +0/-1

Remove TIMEOUT parameter documentation

• Removed TIMEOUT parameter documentation from README
• Removed deprecation notice and usage guidance

tasks/verify-enterprise-contract/0.1/README.md


6. docs/modules/ROOT/pages/verify-conforma-konflux-ta.adoc 📝 Documentation +0/-2

Remove TIMEOUT parameter from documentation

• Removed TIMEOUT parameter documentation from AsciiDoc
• Removed deprecation notice and timeout behavior explanation

docs/modules/ROOT/pages/verify-conforma-konflux-ta.adoc


7. docs/modules/ROOT/pages/verify-conforma-vsa-release-ta.adoc 📝 Documentation +0/-2

Remove TIMEOUT parameter from VSA documentation

• Removed TIMEOUT parameter documentation from AsciiDoc
• Removed deprecation notice and timeout behavior explanation

docs/modules/ROOT/pages/verify-conforma-vsa-release-ta.adoc


8. docs/modules/ROOT/pages/verify-enterprise-contract.adoc 📝 Documentation +0/-2

Remove TIMEOUT parameter from EC documentation

• Removed TIMEOUT parameter documentation from AsciiDoc
• Removed deprecation notice and timeout behavior explanation

docs/modules/ROOT/pages/verify-enterprise-contract.adoc


Grey Divider

Qodo Logo

@qodo-code-review
Copy link
Contributor

Code Review by Qodo

🐞 Bugs (2) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider


Action required

1. TIMEOUT param breaking removal 🐞 Bug ⛯ Reliability
Description
• The PR removes the (deprecated) TIMEOUT param from the v0.1 Tekton Task specs, which is a
  backwards-incompatible contract change for any existing TaskRun/PipelineRun still providing TIMEOUT.
• Because the tasks remain versioned as 0.1 and are used directly for bundle creation, this change
  ships “in place” rather than via a new task version, increasing upgrade risk for downstream users.
Code

tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml[L128-133]

-    - name: TIMEOUT
-      type: string
-      description: >
-        This param is deprecated and will be removed in future. Its value is ignored. EC will
-        be run without a timeout. (If you do want to apply a timeout use the Tekton task timeout.)
-      default: ""
Evidence
The tasks are explicitly versioned as 0.1 and their param list no longer includes TIMEOUT (it goes
from EXTRA_RULE_DATA directly to WORKERS). The release process packages bundles by reading these
exact tasks/.../0.1/...yaml files, so changing the v0.1 task spec in-place changes what downstream
users receive.

tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml[18-132]
docs/modules/ROOT/pages/release-process.adoc[93-103]
tasks/verify-conforma-konflux-ta/0.1/verify-conforma-konflux-ta.yaml[112-126]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The deprecated `TIMEOUT` Tekton param was removed from multiple `0.1` task specs. Even if it was ignored at runtime, removing it from the spec is a breaking interface change for any PipelineRun/TaskRun still passing `TIMEOUT`.

## Issue Context
These tasks are bundled/published by reading the `tasks/.../0.1/*.yaml` files directly, so changing `0.1` in-place changes what downstream users consume.

## Fix Focus Areas
- tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml[119-131]
- tasks/verify-conforma-konflux-ta/0.1/verify-conforma-konflux-ta.yaml[112-126]
- tasks/verify-conforma-konflux-vsa-ta/0.1/verify-conforma-konflux-vsa-ta.yaml[123-139]
- docs/modules/ROOT/pages/release-process.adoc[93-103]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools



Remediation recommended

2. WORKERS docs incorrect 🐞 Bug ✓ Correctness
Description
• The verify-conforma-konflux-ta README claims WORKERS is unused and defaults to 35, but the
  task spec defaults it to 4 and the validate step passes --workers $(params.WORKERS).
• This is factually incorrect documentation that can cause users to misconfigure
  performance/concurrency expectations.
Code

tasks/verify-conforma-konflux-ta/0.1/README.md[34]

* **WORKERS**: Number of parallel workers to use for policy evaluation. This parameter is currently not used. All policy evaluations are run with 35 workers. (default: "35")
Evidence
The README states WORKERS is unused/default 35, but both the task YAML and the published task docs
indicate WORKERS default 4 and the task actually uses it when invoking ec.

tasks/verify-conforma-konflux-ta/0.1/README.md[26-36]
tasks/verify-conforma-konflux-ta/0.1/verify-conforma-konflux-ta.yaml[121-126]
tasks/verify-conforma-konflux-ta/0.1/verify-conforma-konflux-ta.yaml[291-305]
docs/modules/ROOT/pages/verify-conforma-konflux-ta.adoc[55-60]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The `verify-conforma-konflux-ta` README documents `WORKERS` as unused with default 35, but the task spec defaults to 4 and actually passes `--workers $(params.WORKERS)`.

## Issue Context
This file was already modified in the PR, so it’s a good opportunity to correct the remaining stale parameter description.

## Fix Focus Areas
- tasks/verify-conforma-konflux-ta/0.1/README.md[31-36]
- tasks/verify-conforma-konflux-ta/0.1/verify-conforma-konflux-ta.yaml[121-126]
- tasks/verify-conforma-konflux-ta/0.1/verify-conforma-konflux-ta.yaml[291-305]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

ⓘ The new review experience is currently in Beta. Learn more

Grey Divider

Qodo Logo

description: Merge additional Rego variables into the policy data. Use syntax "key=value,key2=value2..."
default: ""

- name: TIMEOUT
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

1. Timeout param breaking removal 🐞 Bug ⛯ Reliability

• The PR removes the (deprecated) TIMEOUT param from the v0.1 Tekton Task specs, which is a
  backwards-incompatible contract change for any existing TaskRun/PipelineRun still providing TIMEOUT.
• Because the tasks remain versioned as 0.1 and are used directly for bundle creation, this change
  ships “in place” rather than via a new task version, increasing upgrade risk for downstream users.
Agent Prompt
## Issue description
The deprecated `TIMEOUT` Tekton param was removed from multiple `0.1` task specs. Even if it was ignored at runtime, removing it from the spec is a breaking interface change for any PipelineRun/TaskRun still passing `TIMEOUT`.

## Issue Context
These tasks are bundled/published by reading the `tasks/.../0.1/*.yaml` files directly, so changing `0.1` in-place changes what downstream users consume.

## Fix Focus Areas
- tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml[119-131]
- tasks/verify-conforma-konflux-ta/0.1/verify-conforma-konflux-ta.yaml[112-126]
- tasks/verify-conforma-konflux-vsa-ta/0.1/verify-conforma-konflux-vsa-ta.yaml[123-139]
- docs/modules/ROOT/pages/release-process.adoc[93-103]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

@codecov
Copy link

codecov bot commented Feb 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
acceptance 55.47% <ø> (ø)
generative 18.59% <ø> (ø)
integration 27.60% <ø> (ø)
unit 68.35% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant