feat: added flags dry-run and max-runs-limit

action.yml

@@ -7,7 +7,13 @@ inputs:
   repository:
     description: Repository name with owner. E.g. actions/checkout
     required: true
+  dry_run:
+    description: Only find stale workflow runs but do not delete anything
+    default: 'false'
+  max_runs_limit:
+    description: Limits the number of fetched workflow runs, e.g. 500. Defaults to 0, meaning no limit set.
+    default: '0'
 outputs: {}
 runs:
-  using: "node16"
-  main: "dist/index.js"
+  using: 'node16'
+  main: 'dist/index.js'

package.json

@@ -8,7 +8,7 @@
     "prepare": "ncc build src/index.ts -o dist --source-map --license licenses.txt --minify",
     "test": "jest",
     "all": "yarn run lint && yarn run prepare && yarn run test",
-    "watch": "ncc build src/index.ts --watch -o dist --source-map --license licenses.txt"
+    "watch": "ncc build src/index.ts --watch -o dist --source-map"
   },
   "engines": {
     "node": "^16"

src/index.spec.ts

@@ -4,6 +4,7 @@ import * as process from 'process';
 
 test('test runs', () => {
   process.env['INPUT_REPOSITORY'] = 'kula-app/remove-stale-workflow-runs';
+  process.env['INPUT_MAX_RUNS_LIMIT'] = '5000';
   const ip = path.join(__dirname, '../', 'dist', 'index.js');
   const result = cp.execSync(`node ${ip}`, { env: process.env }).toString();
   console.log(result);

src/index.ts

@@ -10,13 +10,19 @@ async function run() {
       throw `Invalid repository "${repository}" (needs to have one slash, i.e. 'owner/repo')`;
     }
     const [owner, repo] = repoParts;
-    const authToken = core.getInput('token');
+    const authToken = core.getInput('token', {
+      required: true,
+    });
+    const dryRun = core.getBooleanInput('dry_run');
+    const maxRunsLimit = parseInt(core.getInput('max_runs_limit'));
 
     // -- Perform Tasks --
     await removeStaleWorkflowRuns({
       authToken,
       owner,
       repo,
+      dryRun,
+      maxRunsLimit,
     });
   } catch (error: any) {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access

src/removeStaleWorkflowRuns.ts

@@ -5,10 +5,14 @@ export async function removeStaleWorkflowRuns({
   owner,
   repo,
   authToken,
+  dryRun,
+  maxRunsLimit,
 }: {
   authToken: string;
   owner: string;
   repo: string;
+  dryRun: boolean;
+  maxRunsLimit: number;
 }) {
   const octokit = new Octokit({
     auth: authToken,
@@ -45,11 +49,29 @@ export async function removeStaleWorkflowRuns({
 
   // Fetch all workflow runs
   core.info(`Fetching all workflow runs of repo '${owner}/${repo}' ...`);
-  const runs = await octokit.paginate(octokit.actions.listWorkflowRunsForRepo, {
-    owner: owner,
-    repo: repo,
-    per_page: 100,
-  });
+  if (maxRunsLimit > 0) {
+    core.warning(`Number of workflows is limited to ${maxRunsLimit}`);
+  } else {
+    core.debug(`No limit for workflow runs given`);
+  }
+  let fetchedRunsCounter = 0;
+  const runs = await octokit.paginate(
+    octokit.actions.listWorkflowRunsForRepo,
+    {
+      owner: owner,
+      repo: repo,
+      per_page: 100,
+    },
+    (response, done) => {
+      fetchedRunsCounter += response.data.length;
+      core.debug(`Fetched ${fetchedRunsCounter}/${response.data.total_count} runs...`);
+      if (maxRunsLimit > 0 && fetchedRunsCounter >= maxRunsLimit) {
+        core.warning(`Workflow run limit of ${maxRunsLimit} reached, not fetching further pages!`);
+        done();
+      }
+      return response.data;
+    },
+  );
   if (runs.length === 0) {
     core.info(`No workflow runs found, nothing left to do!`);
     return;
@@ -79,17 +101,25 @@ export async function removeStaleWorkflowRuns({
   for (const [idx, run] of runs.entries()) {
     if (staleBranches.has(run.head_branch)) {
       core.info(
-        `(${idx}/${runs.length}) Workflow run #${run.run_number} used stale branch '${run.head_branch}', deleting it...`,
+        `(${idx + 1}/${runs.length}) Workflow run #${run.run_number} used stale branch '${
+          run.head_branch
+        }', deleting it...`,
       );
-      await octokit.actions.deleteWorkflowRun({
-        owner: owner,
-        repo: repo,
-        run_id: run.id,
-      });
+      if (!dryRun) {
+        await octokit.actions.deleteWorkflowRun({
+          owner: owner,
+          repo: repo,
+          run_id: run.id,
+        });
+      } else {
+        core.warning('Dry run is enabled, not deleting!');
+      }
       counter += 1;
     } else {
       core.info(
-        `(${idx}/${runs.length}) Workflow run #${run.run_number} used active branch '${run.head_branch}', skipping it...`,
+        `(${idx + 1}/${runs.length}) Workflow run #${run.run_number} used active branch '${
+          run.head_branch
+        }', skipping it...`,
       );
     }
   }

tsconfig.json

@@ -3,7 +3,7 @@
     "target": "es2017",
     "moduleResolution": "node",
     "module": "commonjs",
-    "declaration": true,
+    "declaration": false,
     "removeComments": true,
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true,