feat(github-actions): add stale draft PR action

This adds a new behavior to the lock-closed local-action. It automatically closes draft PRs with no activity from the PR author over the past 4 weeks.

Author: thePunderWoman

.prettierignore

@@ -17,6 +17,7 @@ github-actions/saucelabs/set-saucelabs-env.js
 github-actions/labeling/issue/main.js
 github-actions/slash-commands/main.js
 github-actions/unified-status-check/main.js
+github-actions/stale-cleanup/main.js
 bazel/map-size-tracking/test/size-golden.json
 
 **/test/goldens/**/*.md

github-actions/stale-cleanup/BUILD.bazel

@@ -0,0 +1,56 @@
+load("//tools:defaults.bzl", "esbuild_checked_in", "jasmine_test", "ts_project")
+
+package(default_visibility = ["//github-actions/stale-cleanup:__subpackages__"])
+
+ts_project(
+    name = "lib",
+    srcs = glob(
+        ["lib/*.ts"],
+        exclude = ["lib/*.spec.ts"],
+    ),
+    tsconfig = "//github-actions:tsconfig",
+    deps = [
+        "//github-actions:node_modules/@actions/core",
+        "//github-actions:node_modules/@actions/github",
+        "//github-actions:node_modules/@octokit/rest",
+        "//github-actions:node_modules/@types/node",
+        "//github-actions:utils",
+    ],
+)
+
+ts_project(
+    name = "test_lib",
+    testonly = True,
+    srcs = glob(["lib/*.spec.ts"]),
+    tsconfig = "//github-actions:tsconfig_test",
+    deps = [
+        ":lib",
+        "//github-actions:node_modules/@actions/core",
+        "//github-actions:node_modules/@actions/github",
+        "//github-actions:node_modules/@octokit/rest",
+        "//github-actions:node_modules/@types/jasmine",
+        "//github-actions:node_modules/@types/node",
+        "//github-actions:utils",
+    ],
+)
+
+jasmine_test(
+    name = "test",
+    data = [
+        ":test_lib",
+    ],
+    env = {
+        "GITHUB_REPOSITORY": "angular/angular",
+    },
+)
+
+esbuild_checked_in(
+    name = "main",
+    srcs = [
+        ":lib",
+    ],
+    entry_point = "lib/main.ts",
+    format = "esm",
+    platform = "node",
+    target = "node22",
+)

github-actions/stale-cleanup/action.yml

@@ -0,0 +1,10 @@
+name: 'Stale Draft PR Cleanup'
+description: 'Automatically closes draft PRs that have been inactive for a specific number of days.'
+inputs:
+  days:
+    description: 'Number of days a draft PR must be inactive before being closed'
+    required: false
+    default: '28'
+runs:
+  using: 'node22'
+  main: 'main.js'

github-actions/stale-cleanup/lib/main.spec.ts

@@ -0,0 +1,7 @@
+import {closeStaleDraftPrs} from './main.js';
+
+describe('closeStaleDraftPrs', () => {
+  it('should be a function', () => {
+    expect(typeof closeStaleDraftPrs).toBe('function');
+  });
+});

github-actions/stale-cleanup/lib/main.ts

@@ -0,0 +1,101 @@
+import * as core from '@actions/core';
+import {context} from '@actions/github';
+import {Octokit} from '@octokit/rest';
+import {ANGULAR_LOCK_BOT, getAuthTokenFor, revokeActiveInstallationToken} from '../../utils.js';
+
+export async function closeStaleDraftPrs(github: Octokit, repo: string): Promise<void> {
+  const days = parseInt(core.getInput('days', {required: false}) || '28', 10);
+  const message = `This draft PR is being closed because it has been stale for ${days} days and has seen no activity from you. If you'd like to see this change land, you can re-open this PR. Thank you for being an Angular contributor!`;
+
+  const threshold = new Date();
+  threshold.setDate(threshold.getDate() - days);
+  const thresholdIso = threshold.toISOString();
+
+  const repositoryName = `${context.repo.owner}/${repo}`;
+  const query = `repo:${repositoryName} is:pr is:draft is:open updated:<${thresholdIso} sort:updated-asc`;
+  core.info('Stale Draft PR Query: ' + query);
+
+  let closeCount = 0;
+  const prResponse = await github.search.issuesAndPullRequests({
+    q: query,
+    per_page: 100,
+  });
+
+  core.info(`Stale Draft PR Query found ${prResponse.data.total_count} items`);
+
+  if (!prResponse.data.items.length) {
+    core.info(`No draft PRs to close`);
+    return;
+  }
+
+  core.info(`Attempting to close up to ${prResponse.data.items.length} draft PR(s)`);
+  core.startGroup('Closing stale draft PRs');
+
+  for (const item of prResponse.data.items) {
+    if (!item.pull_request) continue;
+
+    try {
+      core.info(`Closing stale draft PR #${item.number}`);
+
+      await github.request('POST /graphql', {
+        query: `
+          mutation CloseStalePR($id: ID!, $body: String!) {
+            addComment(input: {subjectId: $id, body: $body}) {
+              clientMutationId
+            }
+            closePullRequest(input: {pullRequestId: $id}) {
+              pullRequest {
+                state
+              }
+            }
+          }
+        `,
+        variables: {
+          id: item.node_id,
+          body: message,
+        },
+      });
+
+      ++closeCount;
+    } catch (error: unknown) {
+      const e = error as Error & {request?: unknown};
+      core.warning(`Unable to close draft PR ${repositoryName}#${item.number}: ${e.message}`);
+      if (typeof e.request === 'object') {
+        core.error(JSON.stringify(e.request, null, 2));
+      }
+    }
+  }
+
+  core.endGroup();
+  core.info(`Closed ${closeCount} stale draft PR(s)`);
+}
+
+async function main() {
+  const token = await getAuthTokenFor(ANGULAR_LOCK_BOT, {org: 'angular'});
+  const repo = context.repo.repo;
+
+  try {
+    const github = new Octokit({auth: token});
+    await closeStaleDraftPrs(github, repo);
+  } catch (error: any) {
+    core.debug(error.message);
+    core.setFailed(error.message);
+  } finally {
+    await revokeActiveInstallationToken(token);
+  }
+}
+
+// Only run if the action is executed in a repository with is in the Angular org. This is in place
+// to prevent the action from actually running in a fork of a repository with this action set up.
+// Runs triggered via 'workflow_dispatch' are also allowed to run.
+if (context.repo.owner === 'angular' || context.eventName === 'workflow_dispatch') {
+  main().catch((e: Error) => {
+    console.error(e);
+    core.setFailed(e.message);
+  });
+} else {
+  core.warning(
+    'The Stale Draft PR Cleanup was skipped as this action is only meant to run ' +
+      'in repos belonging to the Angular organization.',
+  );
+}