Skip to content

chore(EC-1833): update task descriptions to use Conforma naming#3332

Open
robnester-rh wants to merge 1 commit into
conforma:mainfrom
robnester-rh:EC-1833
Open

chore(EC-1833): update task descriptions to use Conforma naming#3332
robnester-rh wants to merge 1 commit into
conforma:mainfrom
robnester-rh:EC-1833

Conversation

@robnester-rh
Copy link
Copy Markdown
Contributor

Summary

  • Replace "enterprise contract" with "Conforma" in task YAML description and displayName fields
  • Update corresponding doc pages with the same change
  • Task names themselves are not renamed (out of scope)

Test plan

  • Local CodeRabbit review — 0 findings
  • Text-only changes — no functional impact

resolves: EC-1833

🤖 Generated with Claude Code

Replace "enterprise contract" with "Conforma" in task YAML
description and displayName fields, and corresponding docs.
Task names themselves are not renamed (out of scope).

reference: EC-1833

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 4, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: ee22d2e9-63b7-4688-967b-9e1829317cde

📥 Commits

Reviewing files that changed from the base of the PR and between bc9361a and 0d2bd09.

📒 Files selected for processing (4)
  • docs/modules/ROOT/pages/verify-conforma-konflux-ta.adoc
  • docs/modules/ROOT/pages/verify-enterprise-contract.adoc
  • tasks/verify-conforma-konflux-ta/0.1/verify-conforma-konflux-ta.yaml
  • tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml

📝 Walkthrough

Walkthrough

Task and documentation terminology is updated across four files to use "Conforma policy" instead of "enterprise contract". AsciiDoc task documentation synopses and Tekton Task display names and descriptions are changed consistently.

Changes

Conforma policy terminology update

Layer / File(s) Summary
Documentation synopsis updates
docs/modules/ROOT/pages/verify-conforma-konflux-ta.adoc, docs/modules/ROOT/pages/verify-enterprise-contract.adoc
Task documentation synopsis lines updated to reference "Conforma policy" instead of "enterprise contract".
Task definition description updates
tasks/verify-conforma-konflux-ta/0.1/verify-conforma-konflux-ta.yaml, tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml
Tekton Task display names and descriptions updated to reference "Conforma policy" instead of "enterprise contract".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: updating task descriptions to use Conforma naming instead of enterprise contract terminology.
Description check ✅ Passed The description is directly related to the changeset, explaining the replacement of 'enterprise contract' with 'Conforma' in task YAML and documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@qodo-for-conforma
Copy link
Copy Markdown

Review Summary by Qodo

Update task descriptions to use Conforma naming

📝 Documentation

Grey Divider

Walkthroughs

Description
• Replace "enterprise contract" with "Conforma" in task descriptions
• Update task displayName fields to use Conforma terminology
• Update documentation pages with consistent naming
• Text-only changes with no functional impact
Diagram
flowchart LR
  A["Task YAML files"] -- "Update description and displayName" --> B["Conforma terminology"]
  C["Documentation pages"] -- "Update synopsis" --> B

Loading

Grey Divider

File Changes

1. tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml 📝 Documentation +2/-2

Update task displayName and description to Conforma

• Updated tekton.dev/displayName from "Verify Enterprise Contract" to "Verify Conforma"
• Updated spec.description from "Verify the enterprise contract is met" to "Verify the Conforma
 policy is met"

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


2. tasks/verify-conforma-konflux-ta/0.1/verify-conforma-konflux-ta.yaml 📝 Documentation +1/-1

Update task description to Conforma policy

• Updated spec.description from "Verify the enterprise contract is met" to "Verify the Conforma
 policy is met"

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


3. docs/modules/ROOT/pages/verify-enterprise-contract.adoc 📝 Documentation +1/-1

Update documentation synopsis to Conforma

• Updated synopsis from "Verify the enterprise contract is met" to "Verify the Conforma policy is
 met"

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


View more (1)
4. docs/modules/ROOT/pages/verify-conforma-konflux-ta.adoc 📝 Documentation +1/-1

Update documentation synopsis to Conforma

• Updated synopsis from "Verify the enterprise contract is met" to "Verify the Conforma policy is
 met"

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


Grey Divider

Qodo Logo

@qodo-for-conforma
Copy link
Copy Markdown

qodo-for-conforma Bot commented Jun 4, 2026

Code Review by Qodo

🐞 Bugs (2) 📘 Rule violations (0) 🔗 Cross-repo conflicts (0)

Context used
✅ Compliance rules (platform): 27 rules

Grey Divider


Remediation recommended

1. Docs/displayName inconsistent 🐞 Bug ⚙ Maintainability
Description
The task verify-enterprise-contract now exposes tekton.dev/displayName: Verify Conforma, but
documentation still labels it “Verify Enterprise Contract Task”, creating conflicting user-facing
naming across Tekton UIs and docs. This inconsistency makes it harder to correlate the task users
see in Tekton tooling with the doc entry they should click/read.
Code

tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml[23]

+    tekton.dev/displayName: Verify Conforma
Relevance

⭐⭐⭐ High

Team has history of syncing task metadata/docs for consistency (PR #3158 partial, PR #2600 naming
updates).

PR-#3158
PR-#2600

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
The task YAML now advertises the display name as “Verify Conforma”, but the docs index still uses
the old label “Verify Enterprise Contract Task”, causing a direct naming mismatch for the same
task/page.

tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml[20-31]
docs/modules/ROOT/pages/index.adoc[13-16]
tasks/verify-enterprise-contract/0.1/README.md[1-6]

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 Tekton task’s user-facing `tekton.dev/displayName` was changed to “Verify Conforma”, but the documentation index (and task README header) still refer to it as “Verify Enterprise Contract Task”. Align the docs/README naming with the new displayName while keeping the task *name* (`verify-enterprise-contract`) unchanged.

### Issue Context
This PR explicitly updates `description` / `displayName` fields for Conforma naming; leaving the docs index label as “Verify Enterprise Contract Task” is now inconsistent with what users see in Tekton dashboards.

### Fix Focus Areas
- docs/modules/ROOT/pages/index.adoc[13-16]
- tasks/verify-enterprise-contract/0.1/README.md[1-6]
- tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml[20-31]

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


2. Policy terms unclear 🐞 Bug ⚙ Maintainability
Description
The updated task docs’ synopsis now says “Verify the Conforma policy is met”, but the parameter docs
still reference the policy configuration as an EnterpriseContractPolicy and default to
enterprise-contract-service/default without explicitly explaining the naming mismatch. This can
confuse readers about what Kubernetes resource/service they must actually configure.
Code

docs/modules/ROOT/pages/verify-enterprise-contract.adoc[7]

+Verify the Conforma policy is met
Relevance

⭐⭐ Medium

Docs clarity often accepted (PR #3215, #3021), but similar “add warning/clarify behavior” docs notes
were rejected (PR #3158).

PR-#3215
PR-#3021
PR-#3158

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
Both modified doc pages now say “Conforma policy” in the synopsis, but still describe
POLICY_CONFIGURATION as an EnterpriseContractPolicy and default to
enterprise-contract-service/default, without any clarifying note tying the terms together.

docs/modules/ROOT/pages/verify-enterprise-contract.adoc[5-8]
docs/modules/ROOT/pages/verify-enterprise-contract.adoc[27-35]
docs/modules/ROOT/pages/verify-conforma-konflux-ta.adoc[5-24]
tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml[49-58]

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 docs synopsis was updated to “Conforma policy”, but the parameter documentation still uses the underlying API names (`EnterpriseContractPolicy`, `enterprise-contract-service/default`). Add an explicit note near the synopsis/params clarifying that Conforma is the product name while the CRD/service identifiers remain the existing Enterprise Contract names.

### Issue Context
This PR is intentionally not renaming task names/CRDs. However, the synopsis change introduces a terminology mismatch within the same doc page(s) that is easy for users to misinterpret when setting up `POLICY_CONFIGURATION`.

### Fix Focus Areas
- docs/modules/ROOT/pages/verify-enterprise-contract.adoc[5-35]
- docs/modules/ROOT/pages/verify-conforma-konflux-ta.adoc[5-24]
- tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml[49-58]

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


Grey Divider

Qodo Logo

@fullsend-ai-review
Copy link
Copy Markdown

Review

Findings

Info

  • [sub-agent-failure] N/A — The style-conventions sub-agent did not return findings: model claude-sonnet-4-5@20250929 unavailable on vertex deployment. This dimension was not evaluated; for this text-only rename PR, no style concerns are expected.

  • [sub-agent-failure] N/A — The intent-coherence sub-agent did not return findings: model claude-sonnet-4-5@20250929 unavailable on vertex deployment. Orchestrator-level scope check confirms the change matches the claimed chore tier (text-only rename).

  • [sub-agent-failure] N/A — The docs-currency sub-agent did not return findings: model claude-sonnet-4-5@20250929 unavailable on vertex deployment. The PR updates both task YAMLs and their corresponding doc pages in the same change.

@fullsend-ai-review fullsend-ai-review Bot added the ready-for-merge All reviewers approved — ready to merge label Jun 4, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
acceptance 53.54% <ø> (ø)
generative 16.94% <ø> (ø)
integration 27.91% <ø> (ø)
unit 69.02% <ø> (ø)

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

ready-for-merge All reviewers approved — ready to merge size: XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants