fix: actually use the skip-internal-contributors action input

Don't error when `GH_PAT_READ_ORG` is unavailable

Author: plbstl

assets/coverage-report.md

@@ -6,10 +6,10 @@
 
 | Category   | Percentage | Covered/Total |
 | :--------- | :--------: | :-----------: |
-| Statements |    100%    |    176/176    |
-| Branches   |    100%    |     76/76     |
+| Statements |    100%    |    178/178    |
+| Branches   |    100%    |     78/78     |
 | Functions  |    100%    |     21/21     |
-| Lines      |    100%    |    166/166    |
+| Lines      |    100%    |    168/168    |
 
 ## Coverage by File
 

assets/jscpd-report.md

@@ -6,5 +6,5 @@
 
 | Format     | Files analyzed | Total lines | Total tokens | Clones found | Duplicated lines | Duplicated tokens |
 | ---------- | -------------- | ----------- | ------------ | ------------ | ---------------- | ----------------- |
-| typescript | 27             | 2008        | 16100        | 0            | 0 (0%)           | 0 (0%)            |
-| **Total:** | **27**         | **2008**    | **16100**    | **0**        | **0 (0%)**       | **0 (0%)**        |
+| typescript | 27             | 2014        | 16141        | 0            | 0 (0%)           | 0 (0%)            |
+| **Total:** | **27**         | **2014**    | **16141**    | **0**        | **0 (0%)**       | **0 (0%)**        |

assets/tests-report.md

@@ -6,22 +6,22 @@
 
 - **Total Tests**: 68
 - **Test Suites**: 39
-- **Duration**: 941ms
+- **Duration**: 951ms
 
 | Status | File                                                                                           | Tests |  ✅  |  ❌  |  ⏭️ |   ⏳  |
 | :----: | :--------------------------------------------------------------------------------------------- | :---: | :-: | :-: | :-: | :--: |
-|    ✅   | [tests/index.test.ts](#-testsindextestts)                                                      |   1   |  1  |  -  |  -  | 13ms |
+|    ✅   | [tests/index.test.ts](#-testsindextestts)                                                      |   1   |  1  |  -  |  -  | 12ms |
 |    ✅   | [tests/issues.test.ts](#-testsissuestestts)                                                    |   3   |  3  |  -  |  -  |  5ms |
-|    ✅   | [tests/main.test.ts](#-testsmaintestts)                                                        |   11  |  11 |  -  |  -  |  8ms |
+|    ✅   | [tests/main.test.ts](#-testsmaintestts)                                                        |   11  |  11 |  -  |  -  | 11ms |
 |    ✅   | [tests/pull_request.test.ts](#-testspull_requesttestts)                                        |   5   |  5  |  -  |  -  |  8ms |
 |    ✅   | [tests/utils/action-inputs.test.ts](#-testsutilsaction-inputstestts)                           |   9   |  9  |  -  |  -  |  3ms |
 |    ✅   | [tests/utils/add-labels.test.ts](#-testsutilsadd-labelstestts)                                 |   3   |  3  |  -  |  -  |  2ms |
-|    ✅   | [tests/utils/add-reactions.test.ts](#-testsutilsadd-reactionstestts)                           |   6   |  6  |  -  |  -  |  9ms |
+|    ✅   | [tests/utils/add-reactions.test.ts](#-testsutilsadd-reactionstestts)                           |   6   |  6  |  -  |  -  |  7ms |
 |    ✅   | [tests/utils/create-comment.test.ts](#-testsutilscreate-commenttestts)                         |   2   |  2  |  -  |  -  |  2ms |
 |    ✅   | [tests/utils/fc-event.test.ts](#-testsutilsfc-eventtestts)                                     |   6   |  6  |  -  |  -  |  2ms |
-|    ✅   | [tests/utils/is-first-time-contributor.test.ts](#-testsutilsis-first-time-contributortestts)   |   8   |  8  |  -  |  -  |  9ms |
-|    ✅   | [tests/utils/is-internal-contributor.test.ts](#-testsutilsis-internal-contributortestts)       |   8   |  8  |  -  |  -  |  7ms |
-|    ✅   | [tests/utils/is-supported-event.test.ts](#-testsutilsis-supported-eventtestts)                 |   1   |  1  |  -  |  -  |  2ms |
+|    ✅   | [tests/utils/is-first-time-contributor.test.ts](#-testsutilsis-first-time-contributortestts)   |   8   |  8  |  -  |  -  |  7ms |
+|    ✅   | [tests/utils/is-internal-contributor.test.ts](#-testsutilsis-internal-contributortestts)       |   8   |  8  |  -  |  -  |  6ms |
+|    ✅   | [tests/utils/is-supported-event.test.ts](#-testsutilsis-supported-eventtestts)                 |   1   |  1  |  -  |  -  |  1ms |
 |    ✅   | [tests/utils/was-the-first-contribution.test.ts](#-testsutilswas-the-first-contributiontestts) |   5   |  5  |  -  |  -  |  3ms |
 
 ## Details
@@ -53,7 +53,7 @@
   ✅ exits action when the issue or pull request author is NOT a first-time contributor
   ✅ sets the correct action's outputs for issues
   ✅ sets the correct action's outputs for pull requests
-  ✅ throws if GH_PAT_READ_ORG is not set
+  ✅ does not throw if GH_PAT_READ_ORG is not set
 
   ✅ fails the action when `fail-on-error` is enabled
   ✅ doesn't fail the action when `fail-on-error` is disabled

dist/index.js

@@ -53,20 +53,24 @@ export async function run(): Promise<ErrorOccurred> {
     const is_pull_request = !!payload.pull_request
 
     // skip internal contributors
-    const pat_token = process.env['GH_PAT_READ_ORG']
-    if (!pat_token) {
-      throw new Error('GH_PAT_READ_ORG env variable is not set.')
-    }
-    const is_internal = await is_internal_contributor(octokit, pat_token, {
-      author,
-      owner,
-      repo
-    })
-    if (is_internal) {
-      core.info(`@${author} is an internal contributor. Exiting..`)
-      return false
-    } else {
-      core.debug(`@${author} is NOT an internal contributor.`)
+    const should_skip = core.getBooleanInput('skip-internal-contributors')
+    if (should_skip) {
+      const pat_token = process.env['GH_PAT_READ_ORG']
+      if (pat_token) {
+        const is_internal = await is_internal_contributor(octokit, pat_token, {
+          author,
+          owner,
+          repo
+        })
+        if (is_internal) {
+          core.info(`@${author} is an internal contributor. Exiting..`)
+          return false
+        } else {
+          core.debug(`@${author} is NOT an internal contributor.`)
+        }
+      } else {
+        core.info('`GH_PAT_READ_ORG` env variable is unavailable. Cannot skip internal contributors.')
+      }
     }
 
     // check if author is first-timer

dist/index.js.map

@@ -145,18 +145,20 @@ describe('action', () => {
     expect(run_spy).toHaveReturned()
   })
 
-  it('throws if GH_PAT_READ_ORG is not set', async () => {
+  it('does not throw if GH_PAT_READ_ORG is not set', async () => {
     // Supported event
     github_context_mock.eventName = 'pull_request_target'
     github_context_mock.payload.action = 'opened'
     github_context_mock.payload.pull_request = { number: 456, user: { login: 'ghosty' } }
     // remove PAT env
     vitest.unstubAllEnvs()
+    // skip internal contributors
+    core_getBooleanInput_spy.mockReturnValue(true)
 
     await main.run()
 
     expect(is_internal_contributor_spy).not.toHaveBeenCalled()
-    expect(run_spy).toHaveResolvedWith(true)
+    expect(run_spy).toHaveResolvedWith(false)
   })
 
   describe('when an error is thrown', () => {