Cancel workflow runs instead of rejection by default (#16)

* Cancel workflow runs instead of rejection by default

* Fix build

README.md

@@ -19,6 +19,8 @@ This action could be added at the end of the deployment workflow to determine al
 1. Workflow runs triggered off the same branch but later commit than the currently approved workflow run
 2. Workflow run is currently in `waiting` state
 
+These workflow runs will be subject to cancellation (or rejection if preferred).
+
 Alternatively this could be added into a dispatch workflow to periodically cleanup old workflow runs
 
 # How to use it?

action.yml

@@ -5,10 +5,6 @@ branding:
   color: 'red'
 author: 'viveklak'
 inputs:
-  workflow-name:
-    type: string
-    required: false
-    description: The workflow name to look for superseded workflow runs for. Defaults to determining the workflow that the action was used in.
   workflow-run-id:
     type: string
     description: The workflow run ID to start the search for workflows from. Defaults to the current workflow run.
@@ -32,6 +28,10 @@ inputs:
   dry-run:
     description: 'When set doesnt actually delete the workflow runs but simply prints out the workflows that should be deleted.'
     default: 'true'
+  reject-waiting-workflow-runs:
+    type: string
+    description: By default, waiting workflows will be canceled. When set to true, waiting workflows will instead be canceled.
+    default: 'false'
 runs:
   using: 'node16'
   main: 'dist/index.js'

src/main.ts

@@ -69,7 +69,12 @@ async function main(): Promise<void> {
         },
         'waiting'
       ) as workflowRunStatus,
-      dryRun: getBooleanInput('dry-run', {required: false}, true)
+      dryRun: getBooleanInput('dry-run', {required: false}, true),
+      rejectWorkflowRuns: getBooleanInput(
+        'reject-waiting-workflow-runs',
+        {required: false},
+        false
+      )
     })
   } catch (error) {
     if (error instanceof Error) core.setFailed(error.message)

src/run.ts

@@ -14,6 +14,7 @@ export interface RunOpts {
   lastSuccessfulRunId?: number
   status?: workflowRunStatus
   dryRun: boolean
+  rejectWorkflowRuns?: boolean
 }
 
 interface workflowRun {
@@ -133,16 +134,24 @@ export async function run(opts: RunOpts): Promise<void> {
           } waiting on ${deployments.data.map(d => d.environment.name)}`
         )
         if (!opts.dryRun && deployments.data.length > 0) {
-          await octokit.rest.actions.reviewPendingDeploymentsForRun({
-            owner,
-            repo,
-            state: 'rejected',
-            run_id: wf.id,
-            environment_ids: deployments.data
-              .map(d => d.environment.id)
-              .filter((d): d is number => !!d),
-            comment: `Superseded by workflow run ${current_run.html_url}`
-          })
+          if (opts.rejectWorkflowRuns) {
+            await octokit.rest.actions.reviewPendingDeploymentsForRun({
+              owner,
+              repo,
+              state: 'rejected',
+              run_id: wf.id,
+              environment_ids: deployments.data
+                .map(d => d.environment.id)
+                .filter((d): d is number => !!d),
+              comment: `Superseded by workflow run ${current_run.html_url}`
+            })
+          } else {
+            await octokit.rest.actions.cancelWorkflowRun({
+              owner,
+              repo,
+              run_id: wf.id
+            })
+          }
         }
       }
     }