Add documentation and edge case handling for pr_id parameter

Co-authored-by: mikepenz <[email protected]>

Author: Copilot

README.md

@@ -114,6 +114,7 @@ jobs:
 | `truncate_stack_traces`      | Optional. Truncate stack traces from test output to 2 lines in annotations. Defaults to `true`.                                                                                                     |
 | `resolve_ignore_classname`   | Optional. Force ignore test case classname from the xml report (This can help fix issues with some tools/languages). Defaults to `false`.                                                           |
 | `skip_comment_without_tests` | Optional. Disable commenting if no tests are detected. Defaults to `false`.                                                                                                                         |
+| `pr_id`                      | Optional. PR number to comment on (useful for workflow_run contexts where the action runs outside the PR context). When provided, overrides the automatic PR detection.                            |
 
 ### Common Configurations
 
@@ -247,10 +248,16 @@ jobs:
         with:
           commit: ${{github.event.workflow_run.head_sha}}
           report_paths: '**/build/test-results/test/TEST-*.xml'
+          # Optional: if you want to add PR comments from workflow_run context  
+          # comment: true
+          # pr_id: ${{ github.event.workflow_run.pull_requests[0].number }}
 ```
 
 This will securely post the check results from the privileged workflow onto the PR's checks report.
 
+> [!TIP]
+> When running from `workflow_run` context, use the `pr_id` parameter to enable PR comments: `pr_id: ${{ github.event.workflow_run.pull_requests[0].number }}`
+
 </p>
 </details>
 

__tests__/annotator.test.ts

@@ -130,6 +130,82 @@ describe('attachComment', () => {
     })
     expect(mockOctokit.rest.issues.createComment).not.toHaveBeenCalled()
   })
+  it('should warn and return early when pr_id is invalid', async () => {
+    // Setup: no context issue number and invalid pr_id
+    mockContext.issue.number = undefined
+
+    const checkName = ['Test Check']
+    const table = [['Test', 'Result'], ['Example Test', 'Passed']]
+    const prId = 'invalid-number'
+
+    await attachComment(mockOctokit, checkName, false, table, [], [], [], prId)
+
+    // Verify warning was called and no comment was created
+    expect(mockWarning).toHaveBeenCalledWith(
+      expect.stringContaining('Action requires a valid issue number (PR reference) or pr_id input')
+    )
+    expect(mockOctokit.rest.issues.createComment).not.toHaveBeenCalled()
+  })
+
+  it('should handle pr_id with leading/trailing whitespace', async () => {
+    // Setup: no context issue number
+    mockContext.issue.number = undefined
+
+    mockOctokit.paginate.mockResolvedValue([])
+
+    const checkName = ['Test Check']
+    const table = [['Test', 'Result'], ['Example Test', 'Passed']]
+    const prId = '  123  '
+
+    await attachComment(mockOctokit, checkName, false, table, [], [], [], prId)
+
+    // Verify comment was created with correct issue number (whitespace trimmed)
+    expect(mockOctokit.rest.issues.createComment).toHaveBeenCalledWith({
+      owner: 'test-owner',
+      repo: 'test-repo',
+      issue_number: 123,
+      body: expect.stringContaining('Example Test')
+    })
+
+    expect(mockWarning).not.toHaveBeenCalled()
+  })
+
+  it('should update existing comment when pr_id is provided and updateComment is true', async () => {
+    // Setup: no context issue number but pr_id provided
+    mockContext.issue.number = undefined
+
+    const existingComment = {
+      id: 888,
+      body: 'Existing comment <!-- Summary comment for ["Test Check"] by mikepenz/action-junit-report -->'
+    }
+    mockOctokit.paginate.mockResolvedValue([existingComment])
+
+    const checkName = ['Test Check']
+    const table = [['Test', 'Result'], ['Example Test', 'Updated']]
+    const prId = '789'
+
+    await attachComment(mockOctokit, checkName, true, table, [], [], [], prId)
+
+    // Verify paginate was called with correct issue number
+    expect(mockOctokit.paginate).toHaveBeenCalledWith(
+      mockOctokit.rest.issues.listComments,
+      {
+        owner: 'test-owner',
+        repo: 'test-repo',
+        issue_number: 789
+      }
+    )
+
+    // Verify comment was updated
+    expect(mockOctokit.rest.issues.updateComment).toHaveBeenCalledWith({
+      owner: 'test-owner',
+      repo: 'test-repo',
+      comment_id: 888,
+      body: expect.stringContaining('Example Test')
+    })
+    expect(mockOctokit.rest.issues.createComment).not.toHaveBeenCalled()
+  })
+
 })
 
 describe('buildCommentIdentifier', () => {

dist/index.js

@@ -41,7 +41,7 @@ export async function run(): Promise<void> {
     const updateComment = core.getInput('updateComment') === 'true'
     const jobName = core.getInput('job_name')
     const skipCommentWithoutTests = core.getInput('skip_comment_without_tests') === 'true'
-    const prId = core.getInput('pr_id')
+    const prId = core.getInput('pr_id').trim() || undefined
 
     const reportPaths = core.getMultilineInput('report_paths')
     const summary = core.getMultilineInput('summary')