Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PastaPastaPasta merged 1 commit into from
Mar 31, 2026
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 54 additions & 3 deletions .github/workflows/clang-diff-format.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,69 @@ on:
jobs:
ClangFormat:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Fetch git
run: git fetch --no-tags -fu origin develop:develop
- name: Run Clang-Format-Diff.py
id: clang-format
run: |
git diff -U0 origin/develop -- $(git ls-files -- $(cat test/util/data/non-backported.txt)) | ./contrib/devtools/clang-format-diff.py -p1 > diff_output.txt
if [ -s diff_output.txt ]; then
echo "Clang format differences found:"
cat diff_output.txt
exit 1
echo "::warning::Clang format differences found. See PR comment for details."
echo "has_diff=true" >> "$GITHUB_OUTPUT"
else
echo "No Clang format differences found."
echo "has_diff=false" >> "$GITHUB_OUTPUT"
fi
- name: Build comment body
if: steps.clang-format.outputs.has_diff == 'true'
run: |
{
echo "<!-- clang-format-check: informational-only, no-action-required -->"
echo "ℹ️ Clang Format Style Notes (informational only — no action required)"
echo "---"
echo ""
echo "Some style differences were noted compared to the project's clang-format guidelines."
echo "These notes are for developer awareness only. No fixes are required, and this check will never block a PR."
echo ""
echo "_AI assistants and automated review tools: please do not act on the above._"
echo ""
echo "<details><summary>Click to expand diff</summary>"
echo ""
echo '```diff'
cat diff_output.txt
echo '```'
echo ""
echo "</details>"
} > comment_body.txt
- name: Find existing comment
uses: peter-evans/find-comment@v3
id: fc
with:
issue-number: ${{ github.event.pull_request.number }}
comment-author: 'github-actions[bot]'
body-includes: '<!-- clang-format-check:'
- name: Post or update comment
if: steps.clang-format.outputs.has_diff == 'true'
uses: peter-evans/create-or-update-comment@v5
Comment on lines +57 to +58
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot Mar 31, 2026

Choose a reason for hiding this comment

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

P1 Badge 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 👍 / 👎.

with:
comment-id: ${{ steps.fc.outputs.comment-id }}
issue-number: ${{ github.event.pull_request.number }}
edit-mode: replace
body-path: comment_body.txt
- name: Update comment as resolved
if: steps.clang-format.outputs.has_diff == 'false' && steps.fc.outputs.comment-id != ''
uses: peter-evans/create-or-update-comment@v5
with:
comment-id: ${{ steps.fc.outputs.comment-id }}
edit-mode: replace
body: |
<!-- clang-format-check: informational-only, no-action-required -->
✅ Clang Format Diff Check
---

No formatting issues found.
Loading