fix: update invalid work item comment to success upon validation completion

Author: joshjohanning

__tests__/index.test.js

@@ -1454,5 +1454,61 @@ describe('Azure DevOps Commit Validator', () => {
       );
       expect(mockOctokit.rest.issues.createComment).not.toHaveBeenCalled();
     });
+
+    it('should combine invalid work items from both commits and PR title/body into ONE comment', async () => {
+      mockGetInput.mockImplementation(name => {
+        if (name === 'check-commits') return 'true';
+        if (name === 'check-pull-request') return 'true';
+        if (name === 'validate-work-item-exists') return 'true';
+        if (name === 'azure-devops-token') return 'azdo-token';
+        if (name === 'azure-devops-organization') return 'test-org';
+        if (name === 'github-token') return 'github-token';
+        if (name === 'comment-on-failure') return 'true';
+        return 'false';
+      });
+
+      // Commit has invalid work item AB#555558
+      mockOctokit.rest.pulls.listCommits.mockResolvedValue({
+        data: [
+          {
+            sha: 'abc123def456',
+            commit: {
+              message: 'feat: add feature AB#555558'
+            }
+          }
+        ]
+      });
+
+      // PR body has invalid work item AB#55555555
+      mockOctokit.rest.pulls.get.mockResolvedValue({
+        data: {
+          title: 'feat: new feature',
+          body: 'Related to AB#55555555'
+        }
+      });
+
+      mockOctokit.rest.issues.listComments.mockResolvedValue({
+        data: []
+      });
+
+      // Mock both work items as invalid
+      mockValidateWorkItemExists.mockResolvedValue(false);
+
+      await run();
+
+      expect(mockSetFailed).toHaveBeenCalled();
+
+      // Should create ONE comment with both invalid work items
+      expect(mockOctokit.rest.issues.createComment).toHaveBeenCalledTimes(1);
+      expect(mockOctokit.rest.issues.updateComment).not.toHaveBeenCalled();
+
+      const commentCall = mockOctokit.rest.issues.createComment.mock.calls[0][0];
+      expect(commentCall.body).toContain('There are 2 work items');
+      expect(commentCall.body).toContain('AB#555558');
+      expect(commentCall.body).toContain('AB#55555555');
+      // Should show which came from commit vs PR body
+      expect(commentCall.body).toContain('`AB#555558` (commit [`abc123d`]');
+      expect(commentCall.body).toContain('`AB#55555555` (in PR title/body)');
+    });
   });
 });

badges/coverage.svg

@@ -131,6 +131,36 @@ export async function run() {
       core.setFailed(
         `There ${allInvalidWorkItems.length === 1 ? 'is' : 'are'} ${allInvalidWorkItems.length} work item${allInvalidWorkItems.length === 1 ? '' : 's'} that ${allInvalidWorkItems.length === 1 ? 'does' : 'do'} not exist in Azure DevOps`
       );
+    } else if (commentOnFailure && validateWorkItemExistsFlag) {
+      // All work items are valid - check if there's an existing invalid work item comment to update to success
+      const { owner, repo } = context.repo;
+      const comments = await octokit.paginate(octokit.rest.issues.listComments, {
+        owner,
+        repo,
+        issue_number: pullNumber
+      });
+
+      const existingInvalidWorkItemComment = comments.find(comment =>
+        comment.body?.includes(COMMENT_MARKERS.INVALID_WORK_ITEMS)
+      );
+
+      if (existingInvalidWorkItemComment) {
+        console.log(`Found existing invalid work item comment: ${existingInvalidWorkItemComment.id}`);
+        const currentDateTime = new Date().toISOString().replace('T', ' ').substring(0, 19);
+        const commentExtra = `\n\n<details>\n<summary>Workflow run details</summary>\n\n[View workflow run](${context.payload.repository?.html_url}/actions/runs/${context.runId}) - _Last ran: ${currentDateTime} UTC_</details>`;
+        const successCommentCombined =
+          `${COMMENT_MARKERS.INVALID_WORK_ITEMS}\n:white_check_mark: All work items referenced in this pull request now exist in Azure DevOps.` +
+          commentExtra;
+
+        console.log('... attempting to update the invalid work item comment to success');
+        await octokit.rest.issues.updateComment({
+          owner,
+          repo,
+          comment_id: existingInvalidWorkItemComment.id,
+          body: successCommentCombined
+        });
+        console.log('... invalid work item comment updated to success');
+      }
     }
   } catch (error) {
     core.setFailed(`Action failed with error: ${error}`);
@@ -306,36 +336,8 @@ async function checkCommitsForWorkItems(
       return { workItemToCommitMap, invalidWorkItems, hasCommitFailures: false };
     }
 
-    // All work items are valid - check if there's an existing invalid work item comment to update
-    if (commentOnFailure) {
-      const comments = await octokit.paginate(octokit.rest.issues.listComments, {
-        owner,
-        repo,
-        issue_number: pullNumber
-      });
-
-      const existingInvalidWorkItemComment = comments.find(comment =>
-        comment.body?.includes(COMMENT_MARKERS.INVALID_WORK_ITEMS)
-      );
-
-      if (existingInvalidWorkItemComment) {
-        console.log(`Found existing invalid work item comment: ${existingInvalidWorkItemComment.id}`);
-        const currentDateTime = new Date().toISOString().replace('T', ' ').substring(0, 19);
-        const commentExtra = `\n\n<details>\n<summary>Workflow run details</summary>\n\n[View workflow run](${context.payload.repository?.html_url}/actions/runs/${context.runId}) - _Last ran: ${currentDateTime} UTC_</details>`;
-        const successCommentCombined =
-          `${COMMENT_MARKERS.INVALID_WORK_ITEMS}\n:white_check_mark: All work items referenced in this pull request now exist in Azure DevOps.` +
-          commentExtra;
-
-        console.log('... attempting to update the invalid work item comment to success');
-        await octokit.rest.issues.updateComment({
-          owner,
-          repo,
-          comment_id: existingInvalidWorkItemComment.id,
-          body: successCommentCombined
-        });
-        console.log('... invalid work item comment updated to success');
-      }
-    }
+    // All commit work items are valid - return empty array
+    // (Don't update success comment here - let caller handle it after checking PR too)
   }
 
   // Link work items to PR if enabled (after deduplication)