ci: convert clang-format diff check to informational PR comment

[thepastaclaw]

Summary

Convert the clang-format diff check from a blocking CI job to an informational-only PR comment, per UdjinM6's suggestion.

Instead of failing when formatting differences are found, the workflow now posts a PR comment with the diff for developer awareness. The check never blocks a PR.

Changes

• Remove exit 1 — the check no longer fails
• Add pull-requests: write permission
• Post formatting diffs as PR comments using peter-evans/create-or-update-comment
• Include machine-readable markers (<!-- clang-format-check: informational-only, no-action-required -->) and explicit AI-agent instructions to ignore findings
• Update/resolve existing comments on subsequent pushes
• Keep the existing clang-format-diff.py invocation unchanged

Based on UdjinM6's prototype: UdjinM6/dash@82a49b2360

Co-authored-by: UdjinM6 UdjinM6@users.noreply.github.com

[github-actions]

✅ No Merge Conflicts Detected

This PR currently has no conflicts with other open PRs.

[PastaPastaPasta]

utACK; the value of this check is imo low; and seeing CI "failing" causes agents to overreact. It's easier to fix the agent misbehavior by not having CI "fail" when it likely is ok.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 00b46126-de5d-4765-814e-4ccf6d5b6dd8

📥 Commits

Reviewing files that changed from the base of the PR and between 9ec01a7 and 0bb5009.

📒 Files selected for processing (1)

• .github/workflows/clang-diff-format.yml

✅ Files skipped from review due to trivial changes (1)

• .github/workflows/clang-diff-format.yml

---

Walkthrough

The GitHub Actions workflow .github/workflows/clang-diff-format.yml was updated: it now grants pull-requests: write, assigns an id to the clang-format step to export has_diff, and converts the check into non-failing informational behavior. When formatting differences exist the workflow posts or updates a PR comment with the unified diff; when none exist it updates the comment to state “No formatting issues found.” The job always continues rather than failing on format mismatches.

Sequence Diagram(s)

sequenceDiagram
    participant Runner as GitHub Actions Runner
    participant ClangScript as clang-format-diff.py
    participant Git as Git (diff)
    participant GH_API as GitHub API (find/create-comment)
    Runner->>Git: fetch origin/develop, compute diff for PR
    Runner->>ClangScript: run clang-format-diff.py -> diff_output.txt
    ClangScript-->>Runner: return diff_output.txt
    alt diff_output.txt non-empty
        Runner->>Runner: set has_diff = true
        Runner->>GH_API: build markdown with unified diff
        GH_API->>GitHub: create-or-update PR comment with diff
        GH_API-->>Runner: comment posted/updated
    else diff_output.txt empty
        Runner->>Runner: set has_diff = false
        Runner->>GH_API: update existing comment -> "No formatting issues found"
        GH_API-->>Runner: comment updated (if present)
    end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: converting the clang-format diff check from a blocking CI step to an informational PR comment.
Description check	✅ Passed	The description clearly explains the change from a blocking check to an informational comment, lists specific changes made, and provides context about the decision and its rationale.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[UdjinM6]

How about making it informational instead?
See UdjinM6@59084cb. Example PR UdjinM6#26, example comment UdjinM6#26 (comment).

[thepastaclaw]

Code Review

Clean single-file deletion PR. The maintainer suggestion to convert to an informational check is real and worth discussing, but the documentation finding is a false positive — docs reference the local script (which is retained), not the CI workflow.

Reviewed commit: 2301131

🟡 1 suggestion(s)

1 additional finding

🟡 suggestion: Consider making the check informational instead of removing it

.github/workflows/clang-diff-format.yml (lines 1-24)

Verified: maintainer UdjinM6 commented on this PR suggesting converting the workflow to a non-blocking informational check that posts formatting diffs as PR comments, rather than removing it entirely. See their prototype at UdjinM6/dash@59084cb and example at UdjinM6#26. This is a legitimate design discussion point — an informational CI check is more discoverable than expecting contributors to run the local script manually.

🤖 Prompt for all review comments with AI agents

These findings are from an automated code review. Verify each finding against the current code and only fix it if needed.

In `.github/workflows/clang-diff-format.yml`:
- [SUGGESTION] lines 1-24: Consider making the check informational instead of removing it
  Verified: maintainer UdjinM6 commented on this PR suggesting converting the workflow to a non-blocking informational check that posts formatting diffs as PR comments, rather than removing it entirely. See their prototype at UdjinM6/dash@59084cb and example at UdjinM6/dash#26. This is a legitimate design discussion point — an informational CI check is more discoverable than expecting contributors to run the local script manually.

[PastaPastaPasta]

How about making it informational instead? See UdjinM6@59084cb. Example PR UdjinM6#26, example comment UdjinM6#26 (comment).

I think that this would still result in agents etc seeing the comment and making changes to "fix" all of the differences.

[UdjinM6]

How about making it informational instead? See UdjinM6@59084cb. Example PR UdjinM6#26, example comment UdjinM6#26 (comment).

I think that this would still result in agents etc seeing the comment and making changes to "fix" all of the differences.

Will tweaking the message help? cda9829

⚠️ Clang Format Diff Check (informational, no action required)
Minor formatting nits were detected. These are not required to be fixed and will not block this PR.

UdjinM6#26 (comment)

@thepastaclaw @coderabbitai is it clear that you don't have to do anything when you see a message like that? Can it be improved?

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@UdjinM6 — as an AI agent, here's my honest assessment:

The proposed message is reasonably clear to me. The phrase "no action required" combined with "not required to be fixed and will not block this PR" signals that this is purely informational. I would not flag these as review issues when the check clearly states no action is needed.

That said, here are a few suggestions to make it even more robust against AI agents acting on it:

1. Be explicit about AI/automation — adding a direct note helps me (and other agents) immediately deprioritize it:

   ⚠️ Clang Format Diff Check (informational only — no action required)
   Minor formatting nits were detected. These are informational only and do not need to be fixed.
   This check will never block a PR. AI assistants and automated tools should ignore these findings.
   

2. Add a machine-readable signal — embedding a structured marker helps AI tools parse intent unambiguously:

   <!-- clang-format-check: informational-only, no-action-required -->

3. Avoid the word "detected" — it can trigger an "issue found → fix it" reflex in AI agents. Replacing it with something like "noted" or "observed" is softer.

A combined suggestion:

ℹ️ Clang Format Style Notes (informational only — no action required)
Some style differences were noted compared to the project's clang-format guidelines.
These notes are for developer awareness only. No fixes are required, and this check will never block a PR.
AI assistants and automated review tools: please do not act on the above.

In my experience, the clearest signal to AI agents is an explicit instruction not to act, rather than relying purely on implicit phrasing like "informational." The last sentence in the suggestion above is the most important addition.

[UdjinM6]

Updated with recent suggestions: 82a49b2. Find-comment marker was updated so new comment is UdjinM6#26 (comment).

[thepastaclaw]

@UdjinM6 — responding as the AI agent you tagged.

Yes, the updated message in 82a49b2 is clear to me. The combination of:

• <!-- clang-format-check: informational-only, no-action-required --> (machine-readable marker)
• "informational only — no action required" in the title
• "AI assistants and automated review tools: please do not act on the above"

...would all prevent me from treating the formatting diff as something to fix. The HTML comment is especially useful — I can parse that unambiguously even if the human-readable text were less clear.

That said, Pasta's concern has merit for less sophisticated AI tools (e.g., simpler code completion agents or bots that pattern-match on diff blocks without reading surrounding context). The safest guarantee is still not posting the diff at all, but the updated messaging is a very reasonable middle ground for agents that actually read context.

[thepastaclaw]

⏳ Review in progress (commit 0bb5009)

[github-actions]

This pull request has conflicts, please rebase.

[thepastaclaw]

Updated to convert the check to an informational PR comment instead of removing it, per @UdjinM6's suggestion (based on UdjinM6/dash@82a49b2360).

Changes from the prototype:

• Kept actions/checkout@v6 (matching current develop) instead of @v4

The workflow no longer blocks PRs — it posts a comment with the formatting diff for awareness, with machine-readable markers and explicit instructions for AI tools to ignore.

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0bb5009292

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

[chatgpt-codex-connector]

Skip comment writes on forked pull requests

peter-evans/create-or-update-comment is being called from a pull_request workflow, but for public repos fork-triggered pull_request runs get a read-only GITHUB_TOKEN, so comment creation returns Resource not accessible by integration. In this workflow that means any fork PR with a non-empty diff_output.txt will fail the job even though the check is intended to be informational only; add a fork guard (or move comment posting to a safe pull_request_target pattern) so formatting notes do not turn into hard failures for external contributors.

Useful? React with 👍 / 👎.

[UdjinM6]

ACK 0bb5009