Skip to content

fix(ci): exclude vendored TODOs through the canonical scanner - #350

Merged
devantler merged 3 commits into
mainfrom
codex/go-todo-349-round37
Oct 4, 2026
Merged

devantler merged 3 commits into
mainfrom
codex/go-todo-349-round37

Conversation

@devantler

Copy link
Copy Markdown
Contributor

🤖 Generated by the Agentic Engineer

Why

Copied dependency comments can create irrelevant backlog items in new Go projects. The template has not yet adopted the released scanner filter.

What

New projects exclude root vendored comments while keeping their own comments and project integration. The template validates that behavior with the actual scanner image and failure controls.

Fixes #349

@devantler

Copy link
Copy Markdown
Contributor Author

🤖 Generated by the Agentic Engineer

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Oct 4, 2026 •

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai

coderabbitai Bot commented Oct 4, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: cbefa3a3-7954-41ea-a494-5c56161375a6
📥 Commits

Reviewing files that changed from the base of the PR and between 44f821a and db56468.

📒 Files selected for processing (4)
  • .github/scripts/verify-vendored-comment-scan.sh
  • .github/workflows/todos.yaml
  • .github/workflows/validate-scaffold.yaml
  • AGENTS.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📜 Recent review details
🧰 Additional context used
🪛 LanguageTool
AGENTS.md

[uncategorized] ~91-~91: The official name of this software platform is spelled with a capital “H”.
Context: ...ssues or using project credentials. Run `bash .github/scripts/verify-vendored-comment-scan.sh...

(GITHUB)

🔇 Additional comments (4)
.github/workflows/todos.yaml (1)

13-15: LGTM!

.github/scripts/verify-vendored-comment-scan.sh (1)

3-9: LGTM!

Also applies to: 14-79

.github/workflows/validate-scaffold.yaml (1)

50-67: LGTM!

AGENTS.md (1)

87-94: LGTM!


📝 Walkthrough

Walkthrough

The TODO workflow now uses scanner version v6.0.3 and enables vendored-directory filtering. A new script validates the caller and released catalogue workflow, checks fixture behavior, and runs a native scanner scenario with three negative controls. Scaffold validation runs the script against a pinned catalogue checkout. Validation guidance documents the filtering and verification process.

Priority: ➖ Normal

Severity of issue fixed: Medium

Merge Risk: ⚪ Minimal · up to db564

The TODO workflow enables vendored-comment filtering, and scaffold validation checks the pinned scanner configuration and behavior. No actionable merge-blocking issue was identified.

Security Architecture Review

Security architecture risk: 🔵 Low · up to db564

The scanner upgrade preserves the caller’s declared permissions and secret grant, uses an immutable revision, and adds validation in a read-only CI job. No introduced security issue was established, but the external scanner’s effective authority and live issue-handling behavior remain unverified.

Retained concerns
No architecture-level concerns identified.

Security review details

Security Blast Radius

  • inferred — The privileged production boundary remains the external scanner receiving the application private key. Its maximum credential exposure depends on application permissions and installation scope, which the caller does not establish. The unchanged grant is not evidence that the new implementation preserves effective exposure.

Trust Boundaries and Controls

  • observed — The pull-request validation job declares only contents-read permission, does not declare an application-secret grant, and disables credential persistence for both checkouts. Runner egress is audited rather than blocked.
  • observed — The verifier requires the reviewed caller permissions and secret mapping, and checks that the catalogue workflow forwards the filtering inputs through a local action checked out at the workflow’s repository and SHA. These are fail-closed assertions on selected configuration fields, not a complete inspection of external credential use.

Resilience and Maintainability Implications

  • inferred — The replay controls test filtering and expected request payloads, but do not establish live issue-transition invariants across duplicate execution, concurrent runs, interruption, partial failure, cleanup, or recovery. Documentation explicitly describes replay without live issues or project credentials; the external implementation remains necessary to resolve those guarantees.

Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error)

Check name Status Explanation Resolution
Docstring Coverage ❌ Error Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 1 files. (3 skipped: 3 … Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Issue #349’s coding requirements are implemented. .github/workflows/todos.yaml pins the canonical workflow at v6.0.3, enables exclude-vendored, and preserves the existing issues permission and app…
Out of Scope Changes check ✅ Passed The verifier, scaffold workflow, and validation guidance all support issue #349’s scanner adoption and its safety checks. The changes show no unrelated scope.
Title check ✅ Passed The title clearly summarizes the main change: enabling vendored TODO filtering through the canonical scanner.
Description check ✅ Passed The description explains why the template needs vendored-comment filtering and how the change validates that behavior.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 1 files. (3 skipped: 3 unsupported.)

  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@devantler

Copy link
Copy Markdown
Contributor Author

🤖 Generated by the Agentic Engineer

Reviewed the ancillary evaluator output at db56468. Its docstring score identifies no concrete missing source documentation and explicitly marks the Bash items unsupported, so the zero-percent score cannot establish a defect in these shell functions. The literal .github/ path is required repository syntax; the spelling hint cannot apply to that path. No source finding remains from either signal.

The completed current-head CodeRabbit review reports no actionable comments, and all native checks pass. Native run 37223254323 executes the pinned scanner with 13 expected requests and rejects disabled filtering, overbroad filtering and corrupted issue payloads. This replay uses no live project credentials or issue writes; live TODO execution will be verified after merge.

@devantler
devantler marked this pull request as ready for review October 4, 2026 18:27
@devantler
devantler requested a review from a team as a code owner October 4, 2026 18:27
@devantler
devantler merged commit e13188c into main Oct 4, 2026
13 checks passed
@devantler
devantler deleted the codex/go-todo-349-round37 branch October 4, 2026 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(todos): keep vendored comments out of new project backlogs

1 participant