Skip to content

feat: implement issue #506 — Compliance: stub-surface-drift-pr-auto-review.yml-on - #507

Merged
don-petry merged 1 commit into
mainfrom
dev-lead/issue-506-20260731-1422
Aug 2, 2026
Merged

feat: implement issue #506 — Compliance: stub-surface-drift-pr-auto-review.yml-on#507
don-petry merged 1 commit into
mainfrom
dev-lead/issue-506-20260731-1422

Conversation

@don-petry

@don-petry don-petry commented Jul 31, 2026

Copy link
Copy Markdown
Collaborator

User description

Closes #506

Implemented by dev-lead agent. Please review.


CodeAnt-AI Description

Keep the PR auto-review workflow aligned with its central standard

What Changed

  • Preserves the required workflow trigger configuration for PR auto-review
  • Prevents formatting checks from rewriting the workflow and reintroducing configuration drift

Impact

✅ Consistent PR auto-review triggers
✅ Fewer workflow configuration drift failures
✅ Reliable standards compliance

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Summary by CodeRabbit

  • Chores
    • Standardized workflow configuration formatting.
    • Excluded the workflow file from automated formatting to preserve its required structure.

@don-petry
don-petry requested a review from a team as a code owner July 31, 2026 14:28
@codeant-ai

codeant-ai Bot commented Jul 31, 2026

Copy link
Copy Markdown

🤖 CodeAnt AI — Review Status

Status Commit Started (UTC) Finished (UTC)
✅ Reviewed your PR a63075e Jul 31, 2026 · 14:28 14:29

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request updates the .prettierignore file to exclude the .github/workflows/pr-auto-review.yml workflow. This prevents Prettier from formatting the file and introducing drift against the centrally-owned template. There are no review comments, and I have no feedback to provide.

@codeant-ai codeant-ai Bot added the size:XS This PR changes 0-9 lines, ignoring generated files label Jul 31, 2026
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: d8c47e1a-b411-4999-b6e4-4b59485b664e

📥 Commits

Reviewing files that changed from the base of the PR and between 4df9f70 and a63075e.

📒 Files selected for processing (2)
  • .github/workflows/pr-auto-review.yml
  • .prettierignore

📝 Walkthrough

Walkthrough

The PR changes the CI workflow name quoting in the caller stub and adds the workflow to .prettierignore with byte-identity documentation. Workflow behavior remains unchanged.

Changes

Workflow Stub Formatting

Layer / File(s) Summary
Workflow stub formatting and formatter exclusion
.github/workflows/pr-auto-review.yml, .prettierignore
The CI workflow name uses double-quoted YAML syntax. Prettier ignores the workflow and its byte-identity constraint is documented.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Suggested reviewers: donpetry-bot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the compliance fix for the workflow stub drift in issue #506.
Linked Issues check ✅ Passed The PR addresses [#506] by re-syncing the caller stub's on: declaration and preserving standards-owned formatting.
Out of Scope Changes check ✅ Passed The workflow correction and Prettier ignore entry directly support the linked compliance objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dev-lead/issue-506-20260731-1422

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.

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Align pr-auto-review stub quoting and prevent Prettier drift

⚙️ Configuration changes 🕐 Less than 10 minutes

Grey Divider

AI Description

• Match pr-auto-review.yml YAML quoting to the canonical standards stub surface.
• Ignore pr-auto-review.yml in Prettier to prevent byte-level surface drift reappearing.
Diagram

graph TD
  DEV["Repo maintainer"] --> PRET(["Prettier"]) --> IGNORE[".prettierignore"] --> STUB["pr-auto-review.yml"]
  STUB --> GUARD(["stub-drift guard"]) --> CANON{{"Canonical stub (central repo)"}}

  subgraph Legend
    direction LR
    _file["File"] ~~~ _tool(["Tool/Check"]) ~~~ _ext{{"External source"}}
  end
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Override Prettier YAML quoting for workflows
  • ➕ Avoids per-file ignore entries
  • ➕ Keeps workflow files auto-formatted
  • ➖ Repo-wide YAML formatting behavior change may churn unrelated files
  • ➖ Still risks future drift if canonical style changes again
2. Make stub-drift guard normalize quoting/whitespace
  • ➕ More resilient to safe formatting changes
  • ➕ Less need for formatter exclusions
  • ➖ Weakens byte-identical compliance model
  • ➖ More complex guard logic and higher false-negative risk
3. Change canonical stub to match Prettier output
  • ➕ Lets Prettier run without special casing
  • ➕ Keeps local files consistent with formatter defaults
  • ➖ Requires central standards repo change coordination
  • ➖ May break other adopters or existing compliance expectations

Recommendation: Keep the PR’s approach: align the stub’s quoting to the canonical version and add the workflow to .prettierignore. This preserves the strict byte-identical contract enforced by the stub-drift guard without introducing repo-wide formatter behavior changes or weakening compliance validation.

Files changed (2) +8 / -1

Other (2) +8 / -1
pr-auto-review.ymlAlign workflow_run 'workflows' quoting with canonical stub +1/-1

Align workflow_run 'workflows' quoting with canonical stub

• Updates the 'on.workflow_run.workflows' list to use double quotes ('["CI"]') instead of single quotes. This matches the centrally-owned canonical stub surface and avoids compliance drift.

.github/workflows/pr-auto-review.yml

.prettierignoreIgnore pr-auto-review stub to prevent Prettier surface drift +7/-0

Ignore pr-auto-review stub to prevent Prettier surface drift

• Adds '.github/workflows/pr-auto-review.yml' to '.prettierignore' with rationale. Prevents Prettier from rewriting YAML quoting and reintroducing byte-level drift against the standards canonical workflow.

.prettierignore

Comment thread .prettierignore
@sonarqubecloud

Copy link
Copy Markdown

@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

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

Grey Divider

Great, no issues found!

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

Grey Divider

To customize comments, go to the Qodo configuration screen, or learn more in the docs.

Qodo Logo

@don-petry

Copy link
Copy Markdown
Collaborator Author

Note

@don-petry I reviewed this PR and no code changes were needed, but it still has blocking checks or reviews (failing or cancelled checks, or changes-requested reviews), so I cannot mark it done yet. I'll re-check automatically.
Next attempt after: 2026-07-31T15:03:39Z

@don-petry
don-petry enabled auto-merge (squash) July 31, 2026 14:33
@don-petry
don-petry disabled auto-merge July 31, 2026 14:36
@don-petry

Copy link
Copy Markdown
Collaborator Author

Dev-Lead — waiting on PR blockers (intent: review-changes)

PR: #507
No changes were committed, but the PR still has blocking checks or reviews (failing or cancelled checks, or changes-requested reviews). The retry cron will re-attempt automatically. Next attempt after: 2026-07-31T15:09:41Z

@don-petry
don-petry enabled auto-merge (squash) July 31, 2026 14:39

@donpetry-bot donpetry-bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Automated review — APPROVED ✓

Risk: LOW
Reviewed commit: a63075ec0e9cac55dea786e7db62cb4ea520c367
Review mode: triage-approved (single reviewer)

Summary

Byte-syncs the pr-auto-review.yml caller stub's on: surface with the canonical standard (single-quoted 'CI' → double-quoted "CI" in workflow_run.workflows) and adds the stub to .prettierignore with a documented rationale so Prettier's singleQuote config cannot re-introduce the drift. Semantic no-op for YAML; matches the established pattern already used for feature-ideation.yml and other stubs. Verified the head file's on:/permissions surface is byte-identical to petry-projects/.github/standards/workflows/pr-auto-review.yml.

Linked issue analysis

Closes #506 (Compliance: stub-surface-drift-pr-auto-review.yml-on). The compliance finding required re-syncing the stub's centrally-owned on: surface from the canonical template. Verified by diffing the PR head file against the canonical: the on: block is now byte-identical, and the .prettierignore entry prevents the audit finding from recurring. Issue substantively addressed.

Findings

  • No security concerns: change is quote-style only (semantically identical YAML) plus a .prettierignore entry; no trigger, permission, or secret changes.
  • Secret scan: mcp run_secret_scanning tool not available in this environment; gitleaks CI check passed and the diff contains no secret material.
  • Unresolved codeant-ai thread on .prettierignore (file-level ignore breadth) was explicitly declined by the repo owner with documented reasoning (file-level is the only .prettierignore granularity; pattern matches existing stubs), and codeant-ai saved the learning. Treated as addressed.
  • Minor, non-blocking: one residual cosmetic diff vs canonical remains on the uses: line (two spaces vs one before the NOSONAR comment). Outside the enforced on: surface, but since Prettier no longer touches this file, consider syncing it verbatim if the drift guard ever expands scope.

CI status

All validation checks green: build-and-test, Node.js Tests, Playwright, coverage, CodeQL (3 analyzers), gitleaks secret scan, SonarCloud quality gate, agent-shield, dependency audits. The only non-green entries are cancelled/rate-limited Dev-Lead agent orchestration runs (waiting on this review) — not code validation failures.


Reviewed automatically by the PR-review agent (single-reviewer mode: fable 5). Reply if you need a human review.

@don-petry
don-petry disabled auto-merge July 31, 2026 17:54
@don-petry
don-petry enabled auto-merge (squash) July 31, 2026 17:55
@don-petry
don-petry disabled auto-merge July 31, 2026 19:55
@don-petry
don-petry enabled auto-merge (squash) July 31, 2026 19:56
@don-petry
don-petry disabled auto-merge July 31, 2026 21:24
@don-petry
don-petry enabled auto-merge (squash) July 31, 2026 21:25
@don-petry
don-petry disabled auto-merge July 31, 2026 23:18
@don-petry
don-petry enabled auto-merge (squash) July 31, 2026 23:19
@don-petry
don-petry disabled auto-merge August 1, 2026 03:48
@don-petry
don-petry enabled auto-merge (squash) August 1, 2026 03:49
@don-petry
don-petry disabled auto-merge August 1, 2026 06:41
@don-petry
don-petry enabled auto-merge (squash) August 1, 2026 06:41
@don-petry
don-petry disabled auto-merge August 1, 2026 10:10
@don-petry
don-petry enabled auto-merge (squash) August 1, 2026 10:11
@don-petry
don-petry disabled auto-merge August 1, 2026 11:35
@don-petry
don-petry enabled auto-merge (squash) August 1, 2026 11:37
@don-petry
don-petry disabled auto-merge August 1, 2026 13:54
@don-petry
don-petry enabled auto-merge (squash) August 1, 2026 13:55
@don-petry
don-petry disabled auto-merge August 1, 2026 15:18
@don-petry
don-petry enabled auto-merge (squash) August 1, 2026 15:20
@don-petry
don-petry disabled auto-merge August 1, 2026 17:14
@don-petry
don-petry enabled auto-merge (squash) August 1, 2026 17:15
@don-petry
don-petry disabled auto-merge August 1, 2026 19:33
@don-petry
don-petry enabled auto-merge (squash) August 1, 2026 19:35
@don-petry
don-petry disabled auto-merge August 1, 2026 21:09
@don-petry
don-petry enabled auto-merge (squash) August 1, 2026 21:10
@don-petry
don-petry disabled auto-merge August 1, 2026 23:11
@don-petry
don-petry enabled auto-merge (squash) August 1, 2026 23:12
@don-petry
don-petry merged commit 916b6bb into main Aug 2, 2026
54 of 72 checks passed
@don-petry
don-petry deleted the dev-lead/issue-506-20260731-1422 branch August 2, 2026 01:42
don-petry added a commit that referenced this pull request Aug 4, 2026
…eview.yml-on (#507)

Co-authored-by: donpetry-bot <281750570+donpetry-bot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XS This PR changes 0-9 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Compliance: stub-surface-drift-pr-auto-review.yml-on

2 participants