feat: new option skip-comments-on-forks

Author: lucassabreu

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - explanation about forks and token permissions with them.
+- new option `skip-comments-on-forks` to prevent blocking pull requests from forks because of lack of
+  permissions.
 
 ### Changed
 

README.md

@@ -54,6 +54,7 @@ Configuration
 | `table-coverage-change`           | Show only files which their coverage changed equal or above this percentage <br/> Default: `0`                                                                    |
 | `signature`                       | Custom signature to be used at the bottom of the comment. <br/>If you need multiple comments per pull request each step needs to have a unique `signature`        |
 | `github-token`                    | Custom [PAT][pat] to be used instead of the [default action token][default-token], should have the `repo` scope                                                   |
+| `skip-comments-on-forks`          | Should skip trying to comment on [pull requests created from forks](#restrictions-on-forks) <br/> Default: `false`                                                                          |
 
 Example usage
 -------------

action.yml

@@ -73,6 +73,10 @@ inputs:
   signature:
     description: Custom signature to be used at the bottom of the comment
     required: false
+  skip-comments-on-forks:
+    description: Should skip trying to comment on pull requests created from forks
+    default: false
+
 runs:
   using: node20
   main: bin/index.js

assets/summary-example.png

@@ -25,6 +25,7 @@ let baseFile = getInput("base-file") || process.env.BASE_FILE;
 const onlyWithCover = getBooleanInput("only-with-cover");
 const onlyWithCoverableLines = getBooleanInput("only-with-coverable-lines");
 const withChart = getBooleanInput("with-chart");
+const skipCommentOnForks = getBooleanInput("skip-comments-on-forks");
 const withTable = getBooleanInput("with-table");
 const showBranchesColumn = getBooleanInput("with-branches");
 const tableWithOnlyBellow = Number(getInput("table-below-coverage") || 100);
@@ -284,6 +285,16 @@ ${signature}`;
     )
     .write();
 
+  if (context.eventName !== "pull_request") return;
+
+  if (
+    skipCommentOnForks &&
+    `${context.repo.owner}/${context.repo.repo}` !==
+      context.payload.pull_request?.head?.repo?.full_name
+  ) {
+    return;
+  }
+
   let filter = (c: any) => c?.user?.type === "Bot";
 
   try {