Merge pull request #1065 from ldaneliukas/patch-1

Improvements for GitHub Enterprise

README.md

@@ -36,6 +36,7 @@ Inputs are defined in [`action.yml`](action.yml). None are required.:
 | `stale-branch-label` | Label to be applied to issues created for stale branches. <br>**As of v2, this _must_ be unique to this workflow**. | `stale branch 🗑️` |
 | `compare-branches` | This compares each branch to the repo's default branch. <ul><li>When set to `info`, additional output describes if the current branch is ahead, behind, diverged, or identical to the default branch.<br>![image](https://user-images.githubusercontent.com/26232872/157590411-7c97806c-a509-4002-b7a5-a1e4a5da08eb.png)</li> <li>When set to `save`, this prevents branches from being deleted if they are ahead of or diverged from the default branch.</li> <li>When set to `off`, no additional calls are made.</li></ul> | off |
 | `branches-filter-regex` | An optional Regex that will be used to filter branches from this action. | '' |
+| `rate-limit` | If this is enabled, the action will stop if it exceeds 95% of the GitHub API rate limit. | false |
 
 ### Outputs
 Outputs are defined in [`action.yml`](action.yml):
@@ -107,6 +108,7 @@ jobs:
         stale-branch-label: 'stale branch 🗑️'
         compare-branches: 'info'
         branches-filter-regex: '^((?!dependabot))'
+        rate-limit: false
 
 
 ```

__mocks__/@actions/github.ts

@@ -18,7 +18,8 @@ export const validInputs: Inputs = {
   maxIssues: 30,
   tagLastCommitter: true,
   staleBranchLabel: 'stale branch 🗑️',
-  compareBranches: 'save'
+  compareBranches: 'save',
+  rateLimit: true
 }
 
 type ListIssuesResponseDataType = GetResponseTypeFromEndpointMethod<typeof githubActual.github.rest.issues.listForRepo>

__tests__/functions/get-context.test.ts

@@ -135,7 +135,7 @@ describe('Get Context Function', () => {
     await validateInputs()
 
     expect(core.getInput).toHaveBeenCalledTimes(6)
-    expect(core.getBooleanInput).toHaveBeenCalledTimes(2)
+    expect(core.getBooleanInput).toHaveBeenCalledTimes(3)
   })
 
   test('Expect Failure: - TypeError', async () => {

action.yml

@@ -38,6 +38,10 @@ inputs:
     description: 'An optional Regex that will be used to filter branches from this action.'
     required: false
     default: ''
+  rate-limit:
+    description: 'If this is enabled, the action will stop if it exceeds 95% of the GitHub API rate limit.'
+    required: false
+    default: true
 outputs:
   deleted-branches:
     description: 'List of all deleted branches.'

src/functions/get-committer-login.ts

@@ -19,7 +19,8 @@ export async function getRecentCommitLogin(sha: string): Promise<string> {
       per_page: 1,
       page: 1
     })
-    lastCommitter = commitResponse.data.committer!.login
+    const commitData = commitResponse.data
+    lastCommitter = commitData.committer?.login || commitData.author?.login || commitData.commit?.committer?.name || commitData.commit?.author?.name
     assert.ok(lastCommitter, 'Committer cannot be empty.')
   } catch (err) {
     if (err instanceof Error) {

src/functions/get-context.ts

@@ -71,6 +71,8 @@ export async function validateInputs(): Promise<Inputs> {
       throw new Error('branches-filter-regex must be 50 characters or less')
     }
 
+    const inputRateLimit = core.getBooleanInput('rate-limit')
+
     //Assign inputs
     result.daysBeforeStale = inputDaysBeforeStale
     result.daysBeforeDelete = inputDaysBeforeDelete
@@ -80,6 +82,7 @@ export async function validateInputs(): Promise<Inputs> {
     result.staleBranchLabel = inputStaleBranchLabel
     result.compareBranches = inputCompareBranches
     result.branchesFilterRegex = branchesFilterRegex
+    result.rateLimit = inputRateLimit
   } catch (err: unknown) {
     if (err instanceof Error) {
       core.setFailed(`Failed to validate inputs. Error: ${err.message}`)

src/stale-branches.ts

@@ -44,11 +44,13 @@ export async function run(): Promise<void> {
     // Assess Branches
     for (const branchToCheck of branches) {
       // Break if Rate Limit usage exceeds 95%
-      const rateLimit = await getRateLimit()
-      if (rateLimit.used > 95) {
-        core.info(logRateLimitBreak(rateLimit))
-        core.setFailed('Exiting to avoid rate limit violation.')
-        break
+      if (validInputs.rateLimit) {
+        const rateLimit = await getRateLimit()
+        if (rateLimit.used > 95) {
+          core.info(logRateLimitBreak(rateLimit))
+          core.setFailed('Exiting to avoid rate limit violation.')
+          break
+        }
       }
 
       //Get age of last commit, generate issue title, and filter existing issues to current branch
@@ -135,14 +137,15 @@ export async function run(): Promise<void> {
       core.startGroup(logOrphanedIssues(existingIssue.length))
       for (const issueToDelete of existingIssue) {
         // Break if Rate Limit usage exceeds 95%
-        const rateLimit = await getRateLimit()
-        if (rateLimit.used > 95) {
-          core.info(logRateLimitBreak(rateLimit))
-          core.setFailed('Exiting to avoid rate limit violation.')
-          break
-        } else {
-          await closeIssue(issueToDelete.issueNumber)
+        if (validInputs.rateLimit) {
+          const rateLimit = await getRateLimit()
+          if (rateLimit.used > 95) {
+            core.info(logRateLimitBreak(rateLimit))
+            core.setFailed('Exiting to avoid rate limit violation.')
+            break
+          }
         }
+        await closeIssue(issueToDelete.issueNumber)
       }
       core.endGroup()
     }

src/types/inputs.ts

@@ -58,4 +58,13 @@ export interface Inputs {
    * Must be 50 characters or less.
    */
   branchesFilterRegex?: string
+
+  /**
+   * If this is enabled, the action will stop if it exceeds 95% of the GitHub API rate limit.
+   *
+   * Must meet YAML 1.2 "Core Schema" specification.
+   *
+   * Support boolean input list: `true | True | TRUE | false | False | FALSE`.
+   */
+  rateLimit: boolean
 }