fix(scripts/release): fetch origin/main, try pr create first, error if spawn() returns non-zero status (#24914)

* fix(scripts/release): error if spawn() command returns non-zero status

* fix(workflows/release-pr): remove unnecessary "main" ref

* chore(scripts/release): print gh command output

* fix(scripts/release): create PR, fallback to edit PR

* fix(scripts/release): start by fetching main

* fix(scripts/release): diff against origin/main, not main

* fix(scripts/release): create release branch from origin/main

* chore(scripts/release): refine log messages

Author: caugner

.github/workflows/release-pr.yml

@@ -23,7 +23,6 @@ jobs:
         with:
           fetch-depth: 0
           fetch-tags: true
-          ref: main
 
       - name: Setup Node
         uses: actions/setup-node@v4

scripts/release/index.ts

@@ -17,6 +17,7 @@ import {
   getRefDate,
   keypress,
   spawn,
+  fetchMain,
 } from './utils.js';
 
 /**
@@ -53,25 +54,31 @@ const commitAndPR = async (
     console.log('');
   }
 
+  console.log(chalk`{blue Preparing release branch...}`);
   exec(`
     git stash
-    git switch -C ${branch} main
+    git switch -C ${branch} origin/main
     git stash pop
     git add package.json package-lock.json RELEASE_NOTES.md
   `);
 
+  console.log(chalk`{blue Committing changes...}`);
   await temporaryWriteTask(message, (commitFile) =>
     exec(`git commit --file ${commitFile}`),
   );
 
+  console.log(chalk`{blue Pushing release branch...}`);
   exec(`git push --force --set-upstream origin ${branch}`);
 
+  console.log(chalk`{blue Creating/editing pull request...}`);
   await temporaryWriteTask(pr.body, (bodyFile) => {
     const commonArgs = ['--title', pr.title, '--body-file', bodyFile];
     try {
-      spawn('gh', ['pr', 'edit', ...commonArgs]);
+      const stdout = spawn('gh', ['pr', 'create', ...commonArgs]);
+      console.log(stdout);
     } catch (e) {
-      spawn('gh', ['pr', 'create', ...commonArgs]);
+      const stdout = spawn('gh', ['pr', 'edit', ...commonArgs]);
+      console.log(stdout);
     }
   });
 
@@ -88,6 +95,9 @@ const main = async () => {
   requireGitHubCLI();
   requireWriteAccess();
 
+  console.log(chalk`{blue Fetching main branch...}`);
+  fetchMain();
+
   console.log(chalk`{blue Getting last version...}`);
   const lastVersion = getLatestTag();
   const lastVersionDate = getRefDate(lastVersion);
@@ -118,11 +128,10 @@ const main = async () => {
   console.log(chalk`{blue Getting lists of added/removed features...}`);
   const changes = await getChanges(lastVersionDate);
 
-  console.log(chalk`{blue Applying changelog...}`);
+  console.log(chalk`{blue Updating release notes...}`);
   const notes = getNotes(thisVersion, changes, stats, versionBump);
   await addNotes(notes, versionBump, lastVersion);
 
-  console.log(chalk`{blue Creating pull request...}`);
   const title = `Release ${thisVersion}`;
   const body = `(This release was generated by the project's release script.)\n\n${notes}`;
   await commitAndPR(

scripts/release/stats.ts

@@ -54,7 +54,7 @@ const contributors = (): number => {
  */
 const stats = (start: string): ChangeStats => {
   // Get just the diff stats summary
-  const diff = exec(`git diff --shortstat ${start}...main`);
+  const diff = exec(`git diff --shortstat ${start}...origin/main`);
   if (diff === '') {
     console.error(chalk`{red No changes for which to generate statistics.}`);
     process.exit(1);
@@ -73,7 +73,7 @@ const stats = (start: string): ChangeStats => {
   const { changed, insertions, deletions } = match.groups as any;
 
   // Get the number of commits
-  const commits = exec(`git rev-list --count ${start}...main`);
+  const commits = exec(`git rev-list --count ${start}...origin/main`);
 
   return {
     commits: Number(commits),

scripts/release/utils.ts

@@ -37,8 +37,10 @@ export const spawn = (
     throw result.error;
   }
 
-  if (result.stderr) {
-    throw new Error(result.stderr);
+  if (result.status !== 0) {
+    throw new Error(
+      `The command '${command}' returned non-zero exit status ${result.status}: ${result.stderr}`,
+    );
   }
 
   return result.stdout.trim();
@@ -102,6 +104,13 @@ export const queryPRs = (queryArgs: any): any => {
   return JSON.parse(exec(command));
 };
 
+/**
+ * Ensures main is fetched.
+ */
+export const fetchMain = (): void => {
+  exec('git fetch origin main');
+};
+
 /**
  * Get the latest Git tag
  * @returns The latest Git tag