chore(release): add gh checks and include changelogen in the script

Author: tmlmt

scripts/release.mjs

@@ -2,7 +2,6 @@ import fs from "node:fs";
 import path from "node:path";
 import { createInterface } from "node:readline/promises";
 import { execa } from "execa";
-import pkg from "../package.json" with { type: "json" };
 
 // --- Configuration ---
 const CHANGELOG_PATH = path.resolve(process.cwd(), "CHANGELOG.md");
@@ -52,35 +51,77 @@ async function askForConfirmation(question) {
   return answer.toLowerCase().trim();
 }
 
+async function checkPrerequisites() {
+  log.info("Checking prerequisites...");
+
+  // Check for gh CLI installation
+  try {
+    await execa("gh", ["--version"], { stdio: "ignore" });
+  } catch (error) {
+    if (error.code === "ENOENT") {
+      log.error(
+        "GitHub CLI (gh) is not installed. Please install it and try again).",
+      );
+      process.exit(1);
+    }
+    log.error("An unexpected error occurred while checking for gh CLI:");
+    console.error(error);
+    process.exit(1);
+  }
+
+  // Check for gh auth status
+  const authStatus = await execa("gh", ["auth", "status"], { reject: false });
+  if (authStatus.failed) {
+    log.error(
+      'You are not logged into the GitHub CLI. Please run "gh auth login" and try again.',
+    );
+    process.exit(1);
+  }
+
+  log.success("Prerequisites met.");
+}
+
 // --- Main Script ---
 async function main() {
   log.info("Starting release process...");
   if (DRY_RUN) {
     log.info("Running in dry-run mode. No commands will be executed.");
   }
 
-  // 1. Check for staged changes
-  const { stdout: stagedFiles } = await execa("git", [
-    "diff",
-    "--staged",
-    "--name-only",
-  ]);
-  if (!stagedFiles) {
-    log.error(
-      "No staged changes to commit. Stage your changes for the release first (e.g., package.json, CHANGELOG.md).",
+  await checkPrerequisites();
+
+  // 1. Run changelogen to bump version and update changelog
+  log.info("Bumping version and generating changelog with changelogen...");
+  if (DRY_RUN) {
+    log.info("Previewing changelog generation...");
+    // We use execa directly here to bypass the dry-run logic of our `run` helper
+    // and show a preview of what changelogen will do.
+    await execa("pnpx", ["changelogen@latest", "--no-output"], {
+      stdio: "inherit",
+    });
+    const continueAnswer = await askForConfirmation(
+      "Apply file changes and continue with dry-run?",
     );
-    process.exit(1);
+    if (continueAnswer !== "y" && continueAnswer !== "yes") {
+      log.info("Dry-run aborted by user.");
+      process.exit(0);
+    }
+    log.info("Applying changelog changes to proceed with dry-run...");
+    await execa("pnpx", ["changelogen@latest", "--bump"], { stdio: "inherit" });
+  } else {
+    await run("pnpx", ["changelogen@latest", "--bump"]);
   }
-  log.info(`Staged files for release: \n${stagedFiles}`);
 
-  // 2. Get version and construct tag
+  // 2. Get version from the updated package.json
+  const packageJsonPath = path.resolve(process.cwd(), "package.json");
+  const pkg = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
   const { version } = pkg;
   if (!version) {
     log.error("Could not read version from package.json");
     process.exit(1);
   }
   const tag = `v${version}`;
-  log.info(`Found version: ${version}`);
+  log.info(`Version to be released: ${version}`);
 
   // 3. Extract release notes from CHANGELOG.md
   log.info("Extracting release notes from CHANGELOG.md...");
@@ -126,28 +167,45 @@ async function main() {
   }
   log.success("Successfully extracted release notes.");
 
-  if (DRY_RUN) {
-    log.info("--- Extracted Release Notes (for review) ---");
-    const indentedNotes = releaseNotes
-      .split("\n")
-      .map((line) => `  ${line}`)
-      .join("\n");
-    console.log(indentedNotes);
-    log.info("--------------------------------------------");
+  // 4. Show extracted notes for review
+  log.info("--- Release Notes (for review) ---");
+  const indentedNotes = releaseNotes
+    .split("\n")
+    .map((line) => `  ${line}`)
+    .join("\n");
+  console.log(indentedNotes);
+  log.info("----------------------------------");
+
+  // 5. Ask to continue with commit and tag
+  if (!DRY_RUN) {
+    const answer = await askForConfirmation("Proceed with commit and tag?");
+    if (answer !== "y" && answer !== "yes") {
+      log.info("Release aborted by user.");
+      const revertAnswer = await askForConfirmation(
+        "Revert changes to package.json and CHANGELOG.md?",
+      );
+      if (revertAnswer === "y" || revertAnswer === "yes") {
+        await run("git", ["checkout", "package.json", "CHANGELOG.md"]);
+        log.success("Changes have been reverted.");
+      }
+      process.exit(0);
+    }
   }
 
-  // 4. Commit the staged changes
+  // 6. Stage and commit the changes
+  log.info("Staging package.json and CHANGELOG.md...");
+  await run("git", ["add", "package.json", "CHANGELOG.md"]);
   const commitMessage = `chore(release): ${tag}`;
   log.info(`Committing with message: "${commitMessage}"`);
   await run("git", ["commit", "-m", commitMessage]);
 
-  // 5. Create an annotated tag
+  // 7. Create an annotated tag
   log.info(`Creating annotated tag: ${tag}`);
   await run("git", ["tag", "-a", tag, "-m", tag]);
 
   log.success("Local commit and tag created successfully!");
 
-  // 6. Ask to push
+  // 8. Ask to push
   if (!DRY_RUN) {
     const answer = await askForConfirmation("Push commit and tags to remote?");
     if (answer !== "y" && answer !== "yes") {
@@ -170,13 +228,13 @@ async function main() {
     }
   }
 
-  // 7. Push to remote
+  // 9. Push to remote
   log.info("Pushing commit and tags to remote...");
   await run("git", ["push"]);
   await run("git", ["push", "--tags"]);
   log.success("Commit and tags pushed to remote.");
 
-  // 8. Create a GitHub release
+  // 10. Create a GitHub release
   log.info("Creating GitHub release...");
   await run("gh", [
     "release",
@@ -188,7 +246,14 @@ async function main() {
     releaseNotes,
   ]);
 
-  log.success("Release process completed and published successfully!");
+  if (DRY_RUN) {
+    await execa("git", ["checkout", "package.json", "CHANGELOG.md"], {
+      stdio: "inherit",
+    });
+    log.success("Dry-run completed and temporary changes have been reverted.");
+  } else {
+    log.success("Release process completed and published successfully!");
+  }
 }
 
 main().catch((err) => {