ci(align-deps): update existing PR even if no RCs are found (#3734)

Author: tido64

.changeset/long-birds-sing.md

@@ -0,0 +1,2 @@
+---
+---

.github/workflows/align-deps.yml

@@ -29,21 +29,29 @@ jobs:
           yarn build --dependencies
         working-directory: packages/align-deps
       - name: Look for new React Native release candidates
+        id: find-release-candidate
         run: |
-          yarn update-profile --release-candidate > update-profile.output.txt
+          yarn update-profile --release-candidate 1> update-profile.output.txt
+          if [[ -s update-profile.output.txt ]]; then
+            echo 'found=1' >> $GITHUB_OUTPUT
+          fi
         working-directory: packages/align-deps
+        continue-on-error: true
       - name: Include additional capabilities from PR feedback
+        if: ${{ steps.find-release-candidate.outputs.found != '' }}
         run: |
           yarn update-preset
           yarn update-readme
           yarn format
         working-directory: packages/align-deps
       - name: Update local packages with the new profile
+        if: ${{ steps.find-release-candidate.outputs.found != '' }}
         run: |
           yarn rnx-align-deps --write
           yarn install --mode update-lockfile
       - name: Generate changeset
         id: changeset
+        if: ${{ steps.find-release-candidate.outputs.found != '' }}
         run: |
           echo '---' > .changeset/rnx-align-deps.md
           echo '"@rnx-kit/align-deps": patch' >> .changeset/rnx-align-deps.md
@@ -52,14 +60,16 @@ jobs:
           head -n 1 packages/align-deps/update-profile.output.txt >> .changeset/rnx-align-deps.md
           echo "message=$(head -n 1 packages/align-deps/update-profile.output.txt | tr '[:upper:]' '[:lower:]')" >> $GITHUB_OUTPUT
       - name: Generate token for submitting pull requests
-        uses: actions/create-github-app-token@v2
         id: app-token
+        if: ${{ steps.find-release-candidate.outputs.found != '' }}
+        uses: actions/create-github-app-token@v2
         with:
           app-id: ${{ vars.APP_ID }}
           private-key: ${{ secrets.PRIVATE_KEY }}
           permission-contents: write
           permission-pull-requests: write
       - name: Create or update pull request
+        if: ${{ steps.find-release-candidate.outputs.found != '' }}
         uses: peter-evans/create-pull-request@v7
         with:
           token: ${{ steps.app-token.outputs.token }}

package.json

@@ -194,6 +194,14 @@
           "@rnx-kit/babel-plugin-import-path-remapper"
         ]
       },
+      "packages/align-deps": {
+        "entry": [
+          "scripts/*",
+          "src/cli.ts",
+          "src/index.ts",
+          "test/**/*.{js,ts}"
+        ]
+      },
       "packages/cli": {
         "entry": [
           "scripts/**/*.ts",

packages/align-deps/scripts/github.ts

@@ -0,0 +1,86 @@
+import type { OctokitOptions } from "@octokit/core";
+import { Octokit } from "@octokit/core";
+import { restEndpointMethods } from "@octokit/plugin-rest-endpoint-methods";
+import { info } from "@rnx-kit/console";
+import type { Preset } from "../src/types";
+
+type GitHubClient = Octokit & ReturnType<typeof restEndpointMethods>;
+
+const BASE_GITHUB_PARAMS = {
+  owner: "microsoft",
+  repo: "rnx-kit",
+};
+
+const DEFAULT_BRANCH = "rnx-align-deps/main";
+
+const MAGIC_KEYWORD = "@microsoft-react-native-sdk";
+
+function isArray<T>(a: T[] | null | undefined): a is T[] {
+  return Array.isArray(a) && a.length > 0;
+}
+
+export function createGitHubClient(options: OctokitOptions = {}): GitHubClient {
+  return new (Octokit.plugin(restEndpointMethods))(options);
+}
+
+export function fetchPullRequests(
+  octokit: GitHubClient,
+  head = `${BASE_GITHUB_PARAMS.owner}:${DEFAULT_BRANCH}`
+) {
+  return octokit.rest.pulls.list({
+    ...BASE_GITHUB_PARAMS,
+    state: "open",
+    head,
+    base: "main",
+    per_page: 1,
+    page: 1,
+  });
+}
+
+export async function fetchPullRequestFeedback(
+  octokit: GitHubClient,
+  branch = DEFAULT_BRANCH
+) {
+  const head = `${BASE_GITHUB_PARAMS.owner}:${branch}`;
+
+  const pullRequests = await fetchPullRequests(octokit, head);
+  if (!isArray(pullRequests.data)) {
+    info(`No pull requests found for '${head}'`);
+    return;
+  }
+
+  const pr = pullRequests.data[0];
+  const reviewers = pr.requested_reviewers?.map((user) => user.id);
+  if (!isArray(reviewers)) {
+    info(`No reviewers found for pull request #${pr.number}`);
+    return;
+  }
+
+  const comments = await octokit.rest.issues.listComments({
+    ...BASE_GITHUB_PARAMS,
+    issue_number: pr.number,
+  });
+
+  for (const comment of comments.data) {
+    if (
+      !reviewers.includes(comment.user?.id || -1) ||
+      !comment.body?.startsWith(MAGIC_KEYWORD)
+    ) {
+      continue;
+    }
+
+    const m = comment.body.match(/```json([^]*?)```/);
+    if (!m) {
+      continue;
+    }
+
+    try {
+      return JSON.parse(m[1]) as Preset;
+    } catch (e) {
+      info(`Failed to parse JSON from comment: ${e.message}`);
+      continue;
+    }
+  }
+
+  info(`No feedback found for pull request #${pr.number}`);
+}

packages/align-deps/scripts/update-preset.ts

@@ -1,20 +1,13 @@
 #!/usr/bin/env -S node --experimental-strip-types --no-warnings
 
-import { Octokit } from "@octokit/core";
-import { restEndpointMethods } from "@octokit/plugin-rest-endpoint-methods";
 import { info } from "@rnx-kit/console";
 import * as fs from "node:fs";
 import * as recast from "recast";
 import typescript from "recast/parsers/typescript.js";
-import type { MetaPackage, Package, Preset } from "../src/types";
+import type { MetaPackage, Package } from "../src/types";
+import { createGitHubClient, fetchPullRequestFeedback } from "./github.ts";
 import { IGNORED_CAPABILITIES } from "./update-profile.ts";
 
-const MAGIC_KEYWORD = "@microsoft-react-native-sdk";
-
-function isArray<T>(a: T[] | null | undefined): a is T[] {
-  return Array.isArray(a) && a.length > 0;
-}
-
 function isExportNamedDeclaration(
   node: recast.types.namedTypes.Node
 ): node is recast.types.namedTypes.ExportNamedDeclaration {
@@ -89,66 +82,8 @@ function valueLiteral(b: recast.types.builders, value: unknown) {
   }
 }
 
-async function fetchPullRequestFeedback(branch = "rnx-align-deps/main") {
-  const octokit = new (Octokit.plugin(restEndpointMethods))({});
-
-  const baseParams = {
-    owner: "microsoft",
-    repo: "rnx-kit",
-    head: `microsoft:${branch}`,
-  } as const;
-
-  const pullRequests = await octokit.rest.pulls.list({
-    ...baseParams,
-    state: "open",
-    base: "main",
-    per_page: 1,
-    page: 1,
-  });
-
-  if (!isArray(pullRequests.data)) {
-    info(`No pull requests found for '${baseParams.head}'`);
-    return;
-  }
-
-  const pr = pullRequests.data[0];
-  const reviewers = pr.requested_reviewers?.map((user) => user.id);
-  if (!isArray(reviewers)) {
-    info(`No reviewers found for pull request #${pr.number}`);
-    return;
-  }
-
-  const comments = await octokit.rest.issues.listComments({
-    ...baseParams,
-    issue_number: pr.number,
-  });
-
-  for (const comment of comments.data) {
-    if (
-      !reviewers.includes(comment.user?.id || -1) ||
-      !comment.body?.startsWith(MAGIC_KEYWORD)
-    ) {
-      continue;
-    }
-
-    const m = comment.body.match(/```json([^]*?)```/);
-    if (!m) {
-      continue;
-    }
-
-    try {
-      return JSON.parse(m[1]) as Preset;
-    } catch (e) {
-      info(`Failed to parse JSON from comment: ${e.message}`);
-      continue;
-    }
-  }
-
-  info(`No feedback found for pull request #${pr.number}`);
-}
-
 async function main() {
-  const input = await fetchPullRequestFeedback();
+  const input = await fetchPullRequestFeedback(createGitHubClient());
   if (!input) {
     return;
   }

packages/align-deps/scripts/update-profile.ts

@@ -1,5 +1,6 @@
 #!/usr/bin/env -S node --experimental-strip-types --no-warnings
 
+import { error, info } from "@rnx-kit/console";
 import { untar } from "@rnx-kit/tools-shell";
 import { markdownTable } from "markdown-table";
 import * as fs from "node:fs";
@@ -11,6 +12,7 @@ import packageJson from "package-json";
 import semverCoerce from "semver/functions/coerce.js";
 import semverCompare from "semver/functions/compare.js";
 import type { MetaPackage, Package, Preset } from "../src/types.js";
+import { createGitHubClient, fetchPullRequests } from "./github.ts";
 
 type Options = {
   targetVersion?: string;
@@ -203,6 +205,35 @@ async function fetchPackageInfo(
   };
 }
 
+async function fetchReleaseCandidateVersion() {
+  const [latest, next] = await Promise.allSettled([
+    packageJson("react-native", { version: "latest" }),
+    packageJson("react-native", { version: "next" }),
+  ]);
+
+  assertFulfilled(latest, "latest");
+  assertFulfilled(next, "next");
+
+  const latestVersion = latest.value.version;
+  const nextVersion = next.value.version;
+  if (semverCompare(latestVersion, nextVersion) < 0) {
+    return nextVersion;
+  }
+
+  // If the release candidate was recently promoted to stable, we might still
+  // have an open pull request
+  const pullRequest = await fetchPullRequests(createGitHubClient());
+  if (pullRequest.data.length > 0) {
+    const pr = pullRequest.data[0];
+    const m = pr.title.match(/add profile for (\d+\.\d+)$/);
+    if (m) {
+      return m[1];
+    }
+  }
+
+  throw new Error(`No new release candidate available since ${latestVersion}`);
+}
+
 function getPackageVersion(
   packageName: string,
   dependencies?: Record<string, string>
@@ -557,7 +588,7 @@ async function main({
         const [dst, presetFile] = getProfilePath(presetName, targetVersion);
         fs.writeFile(dst, newProfile, () => {
           if (!pullRequest) {
-            console.log(`Wrote to '${dst}'`);
+            info(`Wrote to '${dst}'`);
           }
 
           const profiles = fs
@@ -589,7 +620,7 @@ async function main({
           ].join("\n");
           fs.writeFileSync(presetFile, preset);
           if (!pullRequest) {
-            console.log(`Updated '${presetFile}'`);
+            info(`Updated '${presetFile}'`);
           }
         });
       }
@@ -634,6 +665,8 @@ async function main({
   const collator = new Intl.Collator();
   table.sort((lhs, rhs) => collator.compare(lhs[0], rhs[0]));
   if (table.length > 0) {
+    // The following lines are used for the pull request description; do not use
+    // colors or prefixes
     console.log();
     console.log(markdownTable([headers, ...table]));
   }
@@ -691,30 +724,17 @@ async function parseArgs(): Promise<Options> {
   }
 
   if (options.releaseCandidate) {
-    const [latest, next] = await Promise.allSettled([
-      packageJson("react-native", { version: "latest" }),
-      packageJson("react-native", { version: "next" }),
-    ]);
-
-    assertFulfilled(latest, "latest");
-    assertFulfilled(next, "next");
-
-    const latestVersion = latest.value.version;
-    const nextVersion = next.value.version;
-    if (semverCompare(latestVersion, nextVersion) >= 0) {
-      throw new Error(
-        `No new release candidate available since ${latestVersion}`
-      );
-    }
-
+    const nextVersion = await fetchReleaseCandidateVersion();
     const { major, minor } = coerceVersion(nextVersion);
     const targetVersion = `${major}.${minor}`;
     options.targetVersion = targetVersion;
 
     if (options.pullRequest) {
+      // The following line is used for the pull request description; do not use
+      // colors or prefixes
       console.log("Add profile for", targetVersion);
     } else {
-      console.log("Found release candidate:", nextVersion);
+      info("Found release candidate:", nextVersion);
     }
   }
 
@@ -725,7 +745,7 @@ if (fileURLToPath(import.meta.url) === path.resolve(process.argv[1])) {
   parseArgs()
     .then(main)
     .catch((e: Error) => {
-      console.error(e.message);
+      error(e.message);
       process.exitCode = 1;
     });
 }

packages/align-deps/src/manifest.ts

@@ -45,15 +45,14 @@ export function updateDependencies(
     return dependencies;
   }
 
-  const makeVersionRange = (() => {
+  const makeVersionRange: (versions: Package[]) => string = (() => {
     switch (dependencyType) {
       case "direct":
-        return (versions: Package[]) => versions[versions.length - 1].version;
+        return (versions) => versions[versions.length - 1].version;
       case "development":
-        return (versions: Package[]) => versions[0].version;
+        return (versions) => versions[0].version;
       case "peer":
-        return (versions: Package[]) =>
-          versions.map((pkg) => pkg.version).join(" || ");
+        return (versions) => versions.map((pkg) => pkg.version).join(" || ");
     }
   })();
   const shouldBeAdded = (pkg: Package) =>