Skip to content

docs(#41): update README test-coverage table for per-step resources - #42

Open
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/41-update-readme-test-table
Open

fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/41-update-readme-test-table

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown

Summary

  • Update TestStepTemplate row in the root README test-coverage table to replace "Memory limit, CPU request" with "No shared computeResources in stepTemplate", reflecting the current test_step_template_does_not_share_compute_resources assertion
  • Update TestTaskSteps row to include per-step computeResources validation for use-trusted-artifact (250m CPU, 512Mi/2Gi memory) and build-multi-arch (1 CPU, 4Gi/15Gi memory)

Related Issues

Fixes the stale documentation flagged during review of PR #40, which moved computeResources from the shared stepTemplate to individual steps.

Testing

  • All 46 Tekton tests pass
  • All 93 unit tests pass
  • No secrets detected

Checklist

  • Code follows project conventions
  • Documentation updated if needed

Closes #41

Post-script verification

  • Branch is not main/master (agent/41-update-readme-test-table)
  • Secret scan passed (gitleaks — 300e74d651095922d0df331fbb6c53b991afdec5..HEAD)
  • PR body secret scan passed (gitleaks — no-git)
  • Final PR description secret scan passed (gitleaks — no-git)

Update the root README test-coverage table to reflect the changes
from PR #40 which moved computeResources from stepTemplate to
individual steps:

- TestStepTemplate row: replace "Memory limit, CPU request" with
  "No shared computeResources in stepTemplate" to match the
  test_step_template_does_not_share_compute_resources assertion
- TestTaskSteps row: add per-step computeResources validation
  for use-trusted-artifact (250m CPU, 512Mi/2Gi memory) and
  build-multi-arch (1 CPU, 4Gi/15Gi memory)

Closes #41

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@fullsend-ai-coder fullsend-ai-coder Bot added the ready-for-review Triggers review agent dispatch label Nov 2, 2026
@qodo-for-releng

Copy link
Copy Markdown

Code Review by Qodo

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

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Powered by Qodo

@qodo-for-releng

Copy link
Copy Markdown

PR Summary by Qodo

Align README test coverage with per-step Tekton resources

📝 Documentation 🕐 Less than 5 minutes


AI Description

• Correct the README to show that stepTemplate has no shared computeResources.
• Document the resource requests and limits validated for each task step.
Diagram

graph TD
  A["README coverage"] --> B["Tekton tests"] --> C["Task YAML"]
Loading
High-Level Assessment

Updating the existing coverage table is the most direct way to correct its stale descriptions; no implementation or test changes are needed.

Files changed (1) +2 / -2

Documentation (1) +2 / -2
README.mdCorrect Tekton resource coverage descriptions +2/-2

Correct Tekton resource coverage descriptions

• Replaces the outdated shared-resource description for 'TestStepTemplate' with the assertion that it has no 'computeResources'. Adds the per-step resource requests and limits covered by 'TestTaskSteps'.

README.md

@fullsend-ai-review

fullsend-ai-review Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 5:14 PM UTC · Completed 5:26 PM UTC

Commit: 2eae5f6 · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $2.56

@fullsend-ai-review fullsend-ai-review Bot added the risk/low PR risk: low label Nov 2, 2026
@fullsend-ai-review

Copy link
Copy Markdown

<!-- fullsend:risk-assessment -->
Risk Assessment: low (1/5)

Details

Documentation-only PR (2 additions, 2 deletions in README.md) authored by a bot, closing a well-scoped documentation issue. No protected paths, no security-sensitive files, no CI or dependency changes, and no churn or contention in git history. Every signal across all three tiers is at minimum risk.

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Low

  • [pattern-inconsistency] README.md:162 — stepTemplate is rendered as plain text while computeResources in the same sentence and all other Kubernetes/Tekton field names in the table use backtick code formatting, creating a formatting inconsistency.
    Remediation: Wrap stepTemplate in backticks to match the formatting of other field names in the table.

Labels: PR modifies only README.md documentation

@fullsend-ai-review fullsend-ai-review Bot added ready-for-merge All reviewers approved — ready to merge documentation Improvements or additions to documentation labels Nov 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ready-for-merge All reviewers approved — ready to merge ready-for-review Triggers review agent dispatch risk/low PR risk: low

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update root README test-coverage table after per-step resource change

0 participants