Support Dry Run & No Github Issues Interaction if repo doesn't use is…

…sues (#1228) * Support Dry Run & No Github Issues Interaction if repo doesn't use issues * remove incorrect import * spelling mistake --------- Co-authored-by: Chris Kerins <[email protected]>
crs-k · Aug 2, 2024 · 5c1f814 · 5c1f814
1 parent fdfa282
commit 5c1f814
Show file tree

Hide file tree

Showing 10 changed files with 170 additions and 102 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -59,7 +59,9 @@ jobs:
           stale-branch-label: 'stale branch 🗑️'
           compare-branches: 'info'
           branches-filter-regex: '^((?!dependabot))'
-          pr-check: true
+          pr-check: true        
+          dry-run: false
+          ignore-issue-interaction: false
 
 
   Build:

diff --git a/README.md b/README.md
@@ -36,7 +36,9 @@ Inputs are defined in [`action.yml`](action.yml). None are required.:
 | `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. | true |
-| `pr-check` | If this is enabled, the action will first check for incoming/outgoing PRs associated with the branch. If a branch has an active pr, it will not be ignored. | false |
+| `pr-check` | If this is enabled, the action will first check for incoming/outgoing PRs associated with the branch. If a branch has an active pr, it will be ignored. | false |
+| `dry-run` | If this is enabled, the action will not delete or tag any branches.	| false |
+| `ignore-issue-interaction` | If this is enabled, the action will not interact with Github issues. | false |
 
 ### Outputs
 Outputs are defined in [`action.yml`](action.yml):
@@ -111,6 +113,8 @@ jobs:
         branches-filter-regex: '^((?!dependabot))'
         rate-limit: false
         pr-check: false
+        dry-run: false
+        ignore-issue-interaction: false
 
 
 ```

diff --git a/__mocks__/@actions/github.ts b/__mocks__/@actions/github.ts
@@ -20,7 +20,9 @@ export const validInputs: Inputs = {
   staleBranchLabel: 'stale branch 🗑️',
   compareBranches: 'save',
   rateLimit: true,
-  prCheck: false
+  prCheck: false,
+  dryRun: false,
+  ignoreIssueInteraction: false,
 }
 
 type ListIssuesResponseDataType = GetResponseTypeFromEndpointMethod<typeof githubActual.github.rest.issues.listForRepo>

diff --git a/__tests__/functions/get-context.test.ts b/__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(4)
+    expect(core.getBooleanInput).toHaveBeenCalledTimes(6)
   })
 
   test('Expect Failure: - TypeError', async () => {

diff --git a/action.yml b/action.yml
@@ -41,11 +41,19 @@ inputs:
   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
+    default: 'true'
   pr-check:
     description: 'If this is enabled, the action will first check for active pull requests against the branch. If a branch has an active pr, it will not be ignored.'
     required: false
-    default: false
+    default: 'false'
+  dry-run:
+    description: 'If this is enabled, the action will not delete or tag any branches.'
+    required: false
+    default: 'false'
+  ignore-issue-interaction:
+    description: 'If this is enabled, the action will not interact with Github issues.'
+    required: false
+    default: 'false'
 outputs:
   deleted-branches:
     description: 'List of all deleted branches.'