[workflow] Don't add a comment when the first run of the formatter passes

[tstellar]

This was inadvertently changed in
2120f57.

[llvmbot]

@llvm/pr-subscribers-github-workflow

Author: Tom Stellard (tstellar)

Changes

---

Full diff: https://github.com/llvm/llvm-project/pull/86335.diff

2 Files Affected:

• (modified) .github/workflows/pr-code-format.yml (-1)
• (modified) llvm/utils/git/code-format-helper.py (+2-1)

diff --git a/.github/workflows/pr-code-format.yml b/.github/workflows/pr-code-format.yml
index 2ed9b05cac120f..7adca02930237d 100644
--- a/.github/workflows/pr-code-format.yml
+++ b/.github/workflows/pr-code-format.yml
@@ -34,7 +34,6 @@ jobs:
         uses: actions/checkout@v4
         with:
           reository: ${{ github.repository }}
-          ref: ${{ github.base_ref }}
           sparse-checkout: |
             llvm/utils/git/requirements_formatting.txt
             llvm/utils/git/code-format-helper.py
diff --git a/llvm/utils/git/code-format-helper.py b/llvm/utils/git/code-format-helper.py
index af1bb3b5aec58d..f1207026704e88 100755
--- a/llvm/utils/git/code-format-helper.py
+++ b/llvm/utils/git/code-format-helper.py
@@ -124,7 +124,8 @@ def update_pr(self, comment_text: str, args: FormatArgs, create_new: bool) -> No
         existing_comment = self.find_comment(pr)
 
         if args.write_comment_to_file:
-            self.comment = {"body": comment_text}
+            if create_new or existing_comment:
+                self.comment = {"body": comment_text}
             if existing_comment:
                 self.comment["id"] = existing_comment.id
             return

[tstellar]

This appears to work, but the workflow that adds the comment is now marked as failed since there is no artifact to download. The fix for this is to either have the code-formatter workflow produce an empty comment file or to have the pr-comment file to return success when there is no artifact. I'm thinking maybe the 2nd option is better.

[boomanaiden154]

What are the advantages of the second option? Just producing an empty JSON file seems like the simplest solution to me.

[tstellar]

What are the advantages of the second option? Just producing an empty JSON file seems like the simplest solution to me.

It turns out there is no way to implement the 2nd option anyway, so I just went with the empty JSON.

[boomanaiden154]

LGTM, one comment.

[boomanaiden154]

This was probably here for testing? Needs to be removed before pushing.

[tstellar]

Yeah, I'll drop that commit.

[github-actions]

✅ With the latest revision this PR passed the Python code formatter.

[github-actions]

✅ With the latest revision this PR passed the C/C++ code formatter.

[jayfoad]

Thanks!