Add issue number input parameter

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog of the Jest Coverage Comment
 
+## [Jest Coverage Comment 1.0.28](https://github.com/MishaKav/jest-coverage-comment/tree/v1.0.28)
+
+**Release Date:** 2024-10-27
+
+#### Changes
+
+- Add the ability to specify the `issue-number` of the issue being commented on as an optional argument. Helpfull when triggering the workflow manually (for example `workflow_dispatch` event)
+
 ## [Jest Coverage Comment 1.0.27](https://github.com/MishaKav/jest-coverage-comment/tree/v1.0.27)
 
 **Release Date:** 2024-09-18

README.md

@@ -47,6 +47,7 @@ You can add this action to your GitHub workflow for Ubuntu runners (e.g. `runs-o
 | `multiple-files`            |          | ''                                 | You can pass array of `json-summary.json` files and generate single comment with table of results<br/>Single line should look like `Title1, ./path/to/json-summary.json` |
 | `multiple-junitxml-files`   |          | ''                                 | You can pass array of `junit.xml` files and generate single comment with table of results<br/>Single line should look like `Title1, ./path/to/junit.xml`                 |
 | `unique-id-for-comment`     |          | ''                                 | When running in a matrix, pass the matrix value, so each comment will be updated its own comment `unique-id-for-comment: ${{ matrix.node-version }}`                     |
+| `issue-number`              |          | ''                                 | Specify the issue number to comment on                                                                                                                                   |
 
 ## Output Variables
 
@@ -77,7 +78,7 @@ You can add this action to your GitHub workflow for Ubuntu runners (e.g. `runs-o
 > | Lines                                                                                                                                                                                                               | Statements     | Branches     | Functions  |
 > | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------------ | ---------- |
 > | <a href="https://github.com/MishaKav/api-testing-example/blob/725508e4be6d3bc9d49fa611bd9fba96d5374a13/README.md"><img alt="Coverage: 78%" src="https://img.shields.io/badge/Coverage-78%25-yellow.svg" /></a><br/> | 76.74% (33/43) | 33.33% (2/6) | 100% (0/0) |
->
+
 > ## My JUnit Title
 >
 > | Tests | Skipped | Failures | Errors   | Time               |

action.yml

@@ -104,6 +104,10 @@ inputs:
     default: ''
     required: false
 
+  issue-number:
+    description: 'Specify the issue number to comment on (when triggering the workflow manually)'
+    required: false
+
 outputs:
   coverage:
     description: 'Value indicating the coverage percentage of your report based on Jest, example 78'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-coverage-comment",
-  "version": "1.0.27",
+  "version": "1.0.28",
   "description": "Comments a pull request or commit with the jest code coverage badge, full report and tests summary",
   "author": "Misha Kav <[email protected]>",
   "license": "MIT",

src/create-comment.ts

@@ -13,7 +13,9 @@ export async function createComment(
     const { repo, owner } = context.repo
 
     const octokit = getOctokit(options.token)
-    const issue_number = payload.pull_request ? payload.pull_request.number : 0
+    const issue_number =
+      options.issueNumber ||
+      (payload.pull_request ? payload.pull_request.number : 0)
 
     if (body.length > MAX_COMMENT_LENGTH) {
       const warningsArr = [

src/index.ts

@@ -59,6 +59,7 @@ async function main(): Promise<void> {
     const uniqueIdForComment = core.getInput('unique-id-for-comment', {
       required: false,
     })
+    const issueNumber = core.getInput('issue-number', { required: false })
 
     const serverUrl = context.serverUrl || 'https://github.com'
     core.info(`Uses Github URL: ${serverUrl}`)
@@ -95,6 +96,7 @@ async function main(): Promise<void> {
       reportOnlyChangedFiles,
       multipleFiles,
       multipleJunitFiles,
+      issueNumber: issueNumber ? parseInt(issueNumber) : undefined,
     }
 
     if (eventName === 'pull_request' && payload) {

src/types.d.ts

@@ -25,6 +25,7 @@ export interface Options {
   changedFiles?: ChangedFiles | null
   multipleFiles?: string[]
   multipleJunitFiles?: string[]
+  issueNumber?: number
 }
 
 export interface ChangedFiles {