ci: update comment flow (remix-run#9405)

Author: mcansh

.github/workflows/postrelease.yml

@@ -0,0 +1,17 @@
+name: 🕊 Post-release
+
+on:
+  push:
+    tags:
+      # only run on `react-router` tags
+      - "react-router@*"
+
+jobs:
+  comment:
+    name: 📝 Comment on related issues and pull requests
+    if: github.repository == 'remix-run/react-router'
+    uses: ./.github/workflows/release-comments.yml
+    with:
+      ref: ${{ github.ref }}
+      # this should match the above tag to watch excluding the trailing "@"
+      packageVersionToFollow: "react-router"

.github/workflows/release-comments.yml

@@ -6,6 +6,9 @@ on:
       ref:
         required: true
         type: string
+      packageVersionToFollow:
+        required: true
+        type: string
 
 jobs:
   comment:
@@ -20,16 +23,20 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version-file: ".nvmrc"
-          cache: "yarn"
+          cache: "npm"
+          cache-dependency-path: scripts/release/package-lock.json
 
       - name: 📥 Install deps
-        # even though this is called "npm-install" it does use yarn to install
-        # because we have a yarn.lock and caches efficiently.
-        uses: bahmutov/npm-install@v1
+        run: npm ci
+        working-directory: ./scripts/release
 
       - name: 📝 Comment on issues
-        run: node ./scripts/release/comment.mjs
+        working-directory: ./scripts/release
+        run: node -r esbuild-register ./comment.ts
         env:
           GITHUB_REPOSITORY: ${{ github.repository }}
           GITHUB_TOKEN: ${{ github.token }}
           VERSION: ${{ inputs.ref }}
+          DEFAULT_BRANCH: "main"
+          NIGHTLY_BRANCH: "dev"
+          PACKAGE_VERSION_TO_FOLLOW: ${{ inputs.packageVersionToFollow }}

.github/workflows/release.yml

@@ -55,13 +55,5 @@ jobs:
           publish: yarn release
           createGithubReleases: false
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN_SO_OTHER_ACTIONS_RUN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-  comment:
-    needs: [release]
-    name: 📝 Comment on related issues and pull requests
-    if: github.repository == 'remix-run/react-router'
-    uses: remix-run/react-router/.github/workflows/release-comments.yml@main
-    with:
-      ref: ${{ github.ref }}

scripts/release/comment.mjs

@@ -0,0 +1,114 @@
+import {
+  VERSION,
+  OWNER,
+  REPO,
+  PR_FILES_STARTS_WITH,
+  IS_NIGHTLY_RELEASE,
+  AWAITING_RELEASE_LABEL,
+} from "./constants";
+import {
+  closeIssue,
+  commentOnIssue,
+  commentOnPullRequest,
+  getIssuesClosedByPullRequests,
+  prsMergedSinceLastTag,
+  removeLabel,
+} from "./github";
+import { getGitHubUrl } from "./utils";
+
+async function commentOnIssuesAndPrsAboutRelease() {
+  if (VERSION.includes("experimental")) {
+    return;
+  }
+
+  let { merged, previousTag } = await prsMergedSinceLastTag({
+    owner: OWNER,
+    repo: REPO,
+    githubRef: VERSION,
+  });
+
+  let suffix = merged.length === 1 ? "" : "s";
+  let prFilesDirs = PR_FILES_STARTS_WITH.join(", ");
+  console.log(
+    `Found ${merged.length} PR${suffix} merged ` +
+      `that touched \`${prFilesDirs}\` since ` +
+      `previous release (current: ${VERSION}, previous: ${previousTag})`
+  );
+
+  let promises: Array<ReturnType<typeof commentOnIssue>> = [];
+  let issuesCommentedOn = new Set();
+
+  for (let pr of merged) {
+    console.log(`commenting on pr ${getGitHubUrl("pull", pr.number)}`);
+
+    promises.push(
+      commentOnPullRequest({
+        owner: OWNER,
+        repo: REPO,
+        pr: pr.number,
+        version: VERSION,
+      })
+    );
+
+    let prLabels = pr.labels.map((label) => label.name);
+    let prIsAwaitingRelease = prLabels.includes(AWAITING_RELEASE_LABEL);
+
+    if (!IS_NIGHTLY_RELEASE && prIsAwaitingRelease) {
+      promises.push(
+        removeLabel({ owner: OWNER, repo: REPO, issue: pr.number })
+      );
+    }
+
+    let issuesClosed = await getIssuesClosedByPullRequests(
+      pr.html_url,
+      pr.body
+    );
+
+    for (let issue of issuesClosed) {
+      if (issuesCommentedOn.has(issue.number)) {
+        // we already commented on this issue
+        // so we don't need to do it again
+        continue;
+      }
+
+      issuesCommentedOn.add(issue.number);
+      let issueUrl = getGitHubUrl("issue", issue.number);
+
+      if (IS_NIGHTLY_RELEASE || !prIsAwaitingRelease) {
+        console.log(`commenting on ${issueUrl}`);
+        promises.push(
+          commentOnIssue({
+            owner: OWNER,
+            repo: REPO,
+            issue: issue.number,
+            version: VERSION,
+          })
+        );
+      } else {
+        console.log(`commenting on and closing ${issueUrl}`);
+        promises.push(
+          commentOnIssue({
+            owner: OWNER,
+            repo: REPO,
+            issue: issue.number,
+            version: VERSION,
+          })
+        );
+        promises.push(
+          closeIssue({ owner: OWNER, repo: REPO, issue: issue.number })
+        );
+      }
+    }
+  }
+
+  let result = await Promise.allSettled(promises);
+  let rejected = result.filter((r) => r.status === "rejected");
+  if (rejected.length > 0) {
+    console.log(
+      "🚨 failed to comment on some issues/prs - the most likely reason is they were issues that were turned into discussions, which don't have an api to comment with"
+    );
+    console.log(rejected);
+  }
+}
+
+commentOnIssuesAndPrsAboutRelease();

scripts/release/comment.ts

@@ -0,0 +1,34 @@
+import { cleanupRef, cleanupTagName, isNightly } from "./utils";
+
+if (!process.env.DEFAULT_BRANCH) {
+  throw new Error("DEFAULT_BRANCH is required");
+}
+if (!process.env.NIGHTLY_BRANCH) {
+  throw new Error("NIGHTLY_BRANCH is required");
+}
+if (!process.env.GITHUB_TOKEN) {
+  throw new Error("GITHUB_TOKEN is required");
+}
+if (!process.env.GITHUB_REPOSITORY) {
+  throw new Error("GITHUB_REPOSITORY is required");
+}
+if (!process.env.VERSION) {
+  throw new Error("VERSION is required");
+}
+if (!/^refs\/tags\//.test(process.env.VERSION)) {
+  throw new Error("VERSION must start with refs/tags/");
+}
+if (!process.env.PACKAGE_VERSION_TO_FOLLOW) {
+  throw new Error("PACKAGE_VERSION_TO_FOLLOW is required");
+}
+
+export const [OWNER, REPO] = process.env.GITHUB_REPOSITORY.split("/");
+export const PACKAGE_VERSION_TO_FOLLOW = process.env.PACKAGE_VERSION_TO_FOLLOW;
+export const VERSION = cleanupTagName(cleanupRef(process.env.VERSION));
+export const GITHUB_TOKEN = process.env.GITHUB_TOKEN;
+export const GITHUB_REPOSITORY = process.env.GITHUB_REPOSITORY;
+export const DEFAULT_BRANCH = process.env.DEFAULT_BRANCH;
+export const NIGHTLY_BRANCH = process.env.NIGHTLY_BRANCH;
+export const PR_FILES_STARTS_WITH = ["packages/"];
+export const IS_NIGHTLY_RELEASE = isNightly(VERSION);
+export const AWAITING_RELEASE_LABEL = "awaiting release";