feat: Allows multiple selections for the comment-on option

.github/workflows/test.yml

@@ -70,4 +70,4 @@ jobs:
         with:
           file-coverage-mode: "all"
           json-summary-compare-path: coverage-main/coverage-summary.json
-          comment-on: 'commit'
+          comment-on: 'pr,commit'

README.md

@@ -77,18 +77,18 @@ This action requires the `pull-request: write` permission to add a comment to yo
 
 ### Options
 
-| Option                      | Description                                                                                                                                                                | Default                                                                                                                                                                                                                                                            |
-| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `working-directory`         | The main path to search for coverage- and configuration files (adjusting this is especially useful in monorepos).                                                          | `./`                                                                                                                                                                                                                                                               |
-| `json-summary-path`         | The path to the json summary file.                                                                                                                                         | `${working-directory}/coverage/coverage-summary.json`                                                                                                                                                                                                              |
-| `json-final-path`           | The path to the json final file.                                                                                                                                           | `${working-directory}/coverage/coverage-final.json`                                                                                                                                                                                                                |
-| `vite-config-path`          | The path to the vite config file. Will check the same paths as vite and vitest                                                                                             | Checks pattern `${working-directory}/vite[st].{config                                                                                                                                                                                                              | workspace}.{t\|mt\|ct\|j\|mj\|cj}s` |
-| `github-token`              | A GitHub access token with permissions to write to issues (defaults to `secrets.GITHUB_TOKEN`).                                                                            | `${{ github.token }}`                                                                                                                                                                                                                                              |
-| `file-coverage-mode`        | Defines how file-based coverage is reported. Possible values are `all`, `changes` or `none`.                                                                               | `changes`                                                                                                                                                                                                                                                          |
-| `name`                      | Give the report a custom name. This is useful if you want multiple reports for different test suites within the same PR. Needs to be unique.                               | ''                                                                                                                                                                                                                                                                 |
-| `json-summary-compare-path` | The path to the json summary file to compare against. If given, will display a trend indicator and the difference in the summary. Respects the `working-directory` option. | undefined                                                                                                                                                                                                                                                          |
-| `pr-number`                 | The number of the PR to post a comment to (if any)                                                                                                                         | If in the context of a PR, the number of that PR.<br/> If in the context of a triggered workflow, the PR of the triggering workflow.                                                                    <br/>If no PR context is found, it defaults to `undefined` |
-| `comment-on`                | Select whether you want a comment to appear on a pull-request (if it exists) or on the commit in which context the action was ran.                                         | `pr`                                                                                                                                                                                                                                                               |
+| Option                      | Description                                                                                                                                                                                                                                                      | Default                                                                                                                                                                                                                                                            |
+| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `working-directory`         | The main path to search for coverage- and configuration files (adjusting this is especially useful in monorepos).                                                                                                                                                | `./`                                                                                                                                                                                                                                                               |
+| `json-summary-path`         | The path to the json summary file.                                                                                                                                                                                                                               | `${working-directory}/coverage/coverage-summary.json`                                                                                                                                                                                                              |
+| `json-final-path`           | The path to the json final file.                                                                                                                                                                                                                                 | `${working-directory}/coverage/coverage-final.json`                                                                                                                                                                                                                |
+| `vite-config-path`          | The path to the vite config file. Will check the same paths as vite and vitest                                                                                                                                                                                   | Checks pattern `${working-directory}/vite[st].{config                                                                                                                                                                                                              | workspace}.{t\|mt\|ct\|j\|mj\|cj}s` |
+| `github-token`              | A GitHub access token with permissions to write to issues (defaults to `secrets.GITHUB_TOKEN`).                                                                                                                                                                  | `${{ github.token }}`                                                                                                                                                                                                                                              |
+| `file-coverage-mode`        | Defines how file-based coverage is reported. Possible values are `all`, `changes` or `none`.                                                                                                                                                                     | `changes`                                                                                                                                                                                                                                                          |
+| `name`                      | Give the report a custom name. This is useful if you want multiple reports for different test suites within the same PR. Needs to be unique.                                                                                                                     | ''                                                                                                                                                                                                                                                                 |
+| `json-summary-compare-path` | The path to the json summary file to compare against. If given, will display a trend indicator and the difference in the summary. Respects the `working-directory` option.                                                                                       | undefined                                                                                                                                                                                                                                                          |
+| `pr-number`                 | The number of the PR to post a comment to (if any)                                                                                                                                                                                                               | If in the context of a PR, the number of that PR.<br/> If in the context of a triggered workflow, the PR of the triggering workflow.                                                                    <br/>If no PR context is found, it defaults to `undefined` |
+| `comment-on`                | Specify where you want a comment to appear: "pr" for pull-request (if one can be found), "commit" for the commit in which context the action was run, or "none" for no comments. You can provide a comma-separated list of "pr" and "commit" to comment on both. | `pr`                                                                                                                                                                                                                                                               |
 
 #### File Coverage Mode
 

action.yml

@@ -38,7 +38,7 @@ inputs:
       default: ''
   comment-on:
     required: false
-    description: 'Select wether you want a comment to appear on the PR (if it exists) or on the commit. Uses "pr" by default.'
+    description: 'Specify where you want a comment to appear: "pr" for pull-request (if one can be found), "commit" for the commit in which context the action was run, or "none" for no comments. You can provide a comma-separated list of "pr" and "commit" to comment on both. Uses "pr" by default.'
     default: pr
 runs:
   using: 'node20'

src/index.ts

@@ -3,19 +3,22 @@ import * as github from "@actions/github";
 import { RequestError } from "@octokit/request-error";
 import { FileCoverageMode } from "./inputs/FileCoverageMode.js";
 import { getPullChanges } from "./inputs/getPullChanges.js";
-import { readOptions } from "./inputs/options.js";
+import { type Options, readOptions } from "./inputs/options.js";
 import {
 	parseVitestJsonFinal,
 	parseVitestJsonSummary,
 } from "./inputs/parseJsonReports.js";
-import { createOctokit } from "./octokit.js";
+import { createOctokit, type Octokit } from "./octokit.js";
 import { generateCommitSHAUrl } from "./report/generateCommitSHAUrl.js";
 import { generateFileCoverageHtml } from "./report/generateFileCoverageHtml.js";
 import { generateHeadline } from "./report/generateHeadline.js";
 import { generateSummaryTableHtml } from "./report/generateSummaryTableHtml.js";
 import type { JsonSummary } from "./types/JsonSummary.js";
 import { writeSummaryToCommit } from "./writeSummaryToComment.js";
 import { writeSummaryToPR } from "./writeSummaryToPR.js";
+import { aw } from "vitest/dist/chunks/reporters.C_zwCd4j.js";
+
+type GitHubSummary = typeof core.summary;
 
 const run = async () => {
 	const octokit = createOctokit();
@@ -72,48 +75,72 @@ const run = async () => {
 		`<em>Generated in workflow <a href=${getWorkflowSummaryURL()}>#${github.context.runNumber}</a> for commit <a href="${commitSHAUrl}">${options.commitSHA.substring(0, 7)}</a> by the <a href="https://github.com/davelosert/vitest-coverage-report-action">Vitest Coverage Report Action</a></em>`,
 	);
 
+	if (options.commentOn.includes("pr")) {
+		await commentOnPR(octokit, summary, options);
+	}
+
+	if (options.commentOn.includes("commit")) {
+		await commentOnCommit(octokit, summary, options);
+	}
+
+	await summary.write();
+};
+
+async function commentOnPR(
+	octokit: Octokit,
+	summary: GitHubSummary,
+	options: Options,
+) {
 	try {
-		if (options.commentOn === "pr") {
-			await writeSummaryToPR({
-				octokit,
-				summary,
-				markerPostfix: getMarkerPostfix({
-					name: options.name,
-					workingDirectory: options.workingDirectory,
-				}),
-				prNumber: options.prNumber,
-			});
+		await writeSummaryToPR({
+			octokit,
+			summary,
+			markerPostfix: getMarkerPostfix({
+				name: options.name,
+				workingDirectory: options.workingDirectory,
+			}),
+			prNumber: options.prNumber,
+		});
+	} catch (error) {
+		if (
+			error instanceof RequestError &&
+			(error.status === 404 || error.status === 403)
+		) {
+			core.warning(
+				`Couldn't write a comment to the pull request. Please make sure your job has the permission 'pull-request: write'.
+                 Original Error was: [${error.name}] - ${error.message}`,
+			);
+		} else {
+			throw error;
 		}
+	}
+}
 
-		if (options.commentOn === "commit") {
-			await writeSummaryToCommit({
-				octokit,
-				summary,
-				commitSha: options.commitSHA,
-			});
-		}
+async function commentOnCommit(
+	octokit: Octokit,
+	summary: GitHubSummary,
+	options: Options,
+) {
+	try {
+		await writeSummaryToCommit({
+			octokit,
+			summary,
+			commitSha: options.commitSHA,
+		});
 	} catch (error) {
 		if (
 			error instanceof RequestError &&
 			(error.status === 404 || error.status === 403)
 		) {
-			const item = options.commentOn === "pr" ? "pull request" : "commit";
-			const requiredPermission =
-				options.commentOn === "pr" ? "pull-request: write" : "contents: read";
-
 			core.warning(
-				`Couldn't write a comment to the ${item}. Please make sure your job has the permission '${requiredPermission}'.
-							 Original Error was: [${error.name}] - ${error.message}
-							`,
+				`Couldn't write a comment to the commit. Please make sure your job has the permission 'contents: read'.
+                 Original Error was: [${error.name}] - ${error.message}`,
 			);
 		} else {
-			// Rethrow to handle it in the catch block of the run()-call.
 			throw error;
 		}
 	}
-
-	await summary.write();
-};
+}
 
 function getMarkerPostfix({
 	name,

src/inputs/getCommentOn.test.ts

@@ -0,0 +1,73 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import * as core from "@actions/core";
+import { getCommentOn, type CommentOn } from "./getCommentOn";
+
+vi.mock("@actions/core");
+
+describe("getCommentOn()", () => {
+	beforeEach(() => {
+		vi.clearAllMocks();
+	});
+
+	afterEach(() => {
+		vi.clearAllMocks();
+	});
+
+	it("returns the default value ['pr'] if no valid values are provided", () => {
+		vi.spyOn(core, "getInput").mockReturnValue("invalid1, invalid2");
+
+		const result = getCommentOn();
+		expect(result).toEqual(["pr"]);
+		expect(core.warning).toHaveBeenCalledWith(
+			'No valid options for comment-on found. Falling back to default value "pr".',
+		);
+	});
+
+	it("logs invalid values", () => {
+		vi.spyOn(core, "getInput").mockReturnValue("pr, invalid, commit");
+
+		const result = getCommentOn();
+		expect(result).toEqual(["pr", "commit"]);
+		expect(core.warning).toHaveBeenCalledWith(
+			'Invalid options for comment-on: invalid. Valid options are "pr" and "commit".',
+		);
+	});
+
+	it("returns valid values correctly", () => {
+		vi.spyOn(core, "getInput").mockReturnValue("pr, commit");
+
+		const result = getCommentOn();
+		expect(result).toEqual(["pr", "commit"]);
+		expect(core.warning).not.toHaveBeenCalled();
+	});
+
+	it("trims whitespace from the input", () => {
+		vi.spyOn(core, "getInput").mockReturnValue("pr, commit");
+
+		const result = getCommentOn();
+
+		expect(result).toEqual(["pr", "commit"]);
+
+		expect(core.warning).not.toHaveBeenCalled();
+	});
+
+	it("returns valid values and logs invalid values", () => {
+		vi.spyOn(core, "getInput").mockReturnValue(
+			"pr, invalid, commit, anotherInvalid",
+		);
+
+		const result = getCommentOn();
+		expect(result).toEqual(["pr", "commit"]);
+		expect(core.warning).toHaveBeenCalledWith(
+			'Invalid options for comment-on: invalid, anotherInvalid. Valid options are "pr" and "commit".',
+		);
+	});
+
+	it("for value 'none', returns empty array", () => {
+		vi.spyOn(core, "getInput").mockReturnValue("none");
+
+		const result = getCommentOn();
+
+		expect(result).toEqual([]);
+	});
+});