Deduplicate linter comments (#606)

Author: mattnite

.github/workflows/lint.yml

@@ -1,8 +1,9 @@
 name: Code Linting
 
 on:
-  pull_request_target:
-    types: [opened, synchronize]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
 
 jobs:
   lint:
@@ -27,22 +28,32 @@ jobs:
 
       - name: Run linter
         run: |
-          FILES=$(git diff --name-only --diff-filter=d ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep '\.zig$' || true)
-          echo "changed files: $FILES"
+          echo "Base SHA: ${{ github.event.pull_request.base.sha }}"
+          echo "Head SHA: ${{ github.event.pull_request.head.sha }}"
+
+          # Get changed .zig files
+          FILES=$(git diff --name-only --diff-filter=d ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }} | grep '\.zig$' || true)
+          echo "Changed files: $FILES"
+
           if [ -n "$FILES" ]; then
-            ./tools/linter/zig-out/bin/linter $FILES > lint_results.json
+            echo "$FILES" | xargs ./tools/linter/zig-out/bin/linter > lint_results.json
           else
             echo "[]" > lint_results.json
           fi
 
-      - name: Post comments
+          # Debug output
+          echo "Lint results:"
+          cat lint_results.json
+
+
+      - name: Post comments with metadata
         uses: actions/github-script@v7
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
             const fs = require('fs');
+            const crypto = require('crypto');
 
-            // Check if lint results file exists and has content
             if (!fs.existsSync('lint_results.json')) {
               console.log('No lint results file found');
               return;
@@ -55,9 +66,40 @@ jobs:
             }
 
             const issues = JSON.parse(content);
-            console.log(`Found ${issues.length} lint issues`);
+
+            const existingComments = await github.rest.pulls.listReviewComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.issue.number
+            });
+
+            const botComments = existingComments.data.filter(comment =>
+              comment.user.login === 'github-actions[bot]' &&
+              comment.body.includes('<!-- lint-comment')
+            );
+
+            const existingHashes = new Set();
+            botComments.forEach(comment => {
+              const match = comment.body.match(/<!-- lint-comment:(\w+) -->/);
+              if (match) existingHashes.add(match[1]);
+            });
+
+            let postedCount = 0;
+            let skippedCount = 0;
 
             for (const issue of issues) {
+              const issueData = `${issue.file}:${issue.line}:${issue.message}`;
+              const issueHash = crypto.createHash('md5').update(issueData).digest('hex').substring(0, 8);
+
+              if (existingHashes.has(issueHash)) {
+                console.log(`Skipping duplicate issue: ${issueHash}`);
+                skippedCount++;
+                continue;
+              }
+
+              const commentBody = `${issue.message}\n\n<!-- lint-comment:${issueHash} -->\n`;
+              console.log(`comment body:`, commentBody);
+
               try {
                 await github.rest.pulls.createReviewComment({
                   owner: context.repo.owner,
@@ -66,10 +108,12 @@ jobs:
                   commit_id: context.payload.pull_request.head.sha,
                   path: issue.file,
                   line: issue.line,
-                  body: issue.message
+                  body: commentBody
                 });
-                console.log(`Posted comment for ${issue.file}:${issue.line}`);
+                postedCount++;
               } catch (error) {
-                console.error(`Failed to post comment for ${issue.file}:${issue.line}:`, error.message);
+                console.error(`Failed to post comment:`, error.message);
               }
             }
+
+            console.log(`Posted ${postedCount} new comments, skipped ${skippedCount} duplicates`);

build.zig

@@ -862,3 +862,5 @@ inline fn custom_find_import_pkg_hash_or_fatal(comptime dep_name: []const u8) []
 
     @panic("dependency not found");
 }
+
+fn myFunc() void {}

port/nordic/nrf5x/src/hal.zig

@@ -24,3 +24,5 @@ test "hal tests" {
 
     _ = drivers;
 }
+
+pub fn myFunc() void {}