git-stack-cli 2.4.1 → 2.5.0

package/dist/js/index.js

@@ -38415,6 +38415,8 @@ GitReviseTodo.todo = function todo(args) {
   return todo2;
 };
 GitReviseTodo.execute = async function grt_execute(args) {
+  const argv = Store.getState().argv;
+  const actions = Store.getState().actions;
   const GIT_SEQUENCE_EDITOR_SCRIPT = `#!/bin/sh
 
 # Example
@@ -38472,10 +38474,30 @@ echo
   const command = [
     `GIT_EDITOR="${tmp_git_sequence_editor_path}"`,
     `GIT_REVISE_TODO="${tmp_path_git_revise_todo}"`,
-    `git`,
-    `revise --edit -i ${args.rebase_merge_base}`
+    `git`
   ];
-  await cli(command, { stdio: ["pipe", "pipe", "pipe"] });
+  if (!argv["revise-sign"]) {
+    command.push(...["-c", "commit.gpgsign=false"]);
+  }
+  command.push(`revise --edit -i ${args.rebase_merge_base}`);
+  try {
+    await cli(command, { stdio: ["pipe", "pipe", "pipe"] });
+  } catch (err) {
+    if (err instanceof Error) {
+      actions.error(err.message);
+      if (err.message.includes("gpg failed to sign commit")) {
+        actions.error(`
+
+`);
+        actions.error("\uD83D\uDEA8 git revise failed to sign commit");
+        actions.error("\uD83D\uDCA1 Try again with `--no-revise-sign`?");
+        actions.error(`
+
+`);
+        actions.exit(21);
+      }
+    }
+  }
   await safe_rm(tmp_git_sequence_editor_path);
 };
 
@@ -45662,7 +45684,7 @@ var yargs_default = Yargs;
 
 // src/command.ts
 async function command2() {
-  return yargs_default(hideBin(process.argv)).scriptName("git stack").usage("Usage: git stack [command] [options]").command("$0", "Sync commit ranges to Github", (yargs) => yargs.options(DefaultOptions)).command("fixup [commit]", "Amend staged changes to a specific commit in history", (yargs) => yargs.positional("commit", FixupOptions.commit)).command("log [args...]", "Print an abbreviated log with numbered commits, useful for git stack fixup", (yargs) => yargs.strict(false)).command("rebase", "Update local branch via rebase with latest changes from origin master branch", (yargs) => yargs).option("verbose", GlobalOptions.verbose).wrap(123).strict().version("2.4.1").showHidden("show-hidden", "Show hidden options via `git stack help --show-hidden`").help("help", "Show usage via `git stack help`").argv;
+  return yargs_default(hideBin(process.argv)).scriptName("git stack").usage("Usage: git stack [command] [options]").command("$0", "Sync commit ranges to Github", (yargs) => yargs.options(DefaultOptions)).command("fixup [commit]", "Amend staged changes to a specific commit in history", (yargs) => yargs.positional("commit", FixupOptions.commit)).command("log [args...]", "Print an abbreviated log with numbered commits, useful for git stack fixup", (yargs) => yargs.strict(false)).command("rebase", "Update local branch via rebase with latest changes from origin master branch", (yargs) => yargs).option("verbose", GlobalOptions.verbose).wrap(123).strict().version("2.5.0").showHidden("show-hidden", "Show hidden options via `git stack help --show-hidden`").help("help", "Show usage via `git stack help`").argv;
 }
 var GlobalOptions = {
   verbose: {
@@ -45694,7 +45716,11 @@ var DefaultOptions = {
   verify: {
     type: "boolean",
     default: true,
-    description: "Run git hooks such as pre-commit and pre-push, disable with --no-verify"
+    description: [
+      "Run git hooks such as pre-commit and pre-push",
+      "Disable with --no-verify"
+    ].join(`
+`)
   },
   update: {
     type: "boolean",
@@ -45705,7 +45731,11 @@ var DefaultOptions = {
   branch: {
     type: "string",
     alias: ["b"],
-    description: 'Set the master branch name, defaults to "origin/master" (or "origin/main" if "origin/master" is not found)'
+    description: [
+      "Set the master branch name, defaults to 'origin/master'",
+      "(or 'origin/main' if 'origin/master' is not found)"
+    ].join(`
+`)
   },
   draft: {
     type: "boolean",
@@ -45718,10 +45748,19 @@ var DefaultOptions = {
     default: "",
     description: "Prefix for generated branch names, e.g. dev/magus/"
   },
+  "revise-sign": {
+    type: "boolean",
+    default: true,
+    description: "Disable GPG signing for git revise with --no-revise-sign"
+  },
   template: {
     type: "boolean",
     default: true,
-    description: "Use automatic Github PR template, e.g. .github/pull_request_template.md, disable with --no-template"
+    description: [
+      "Use automatic Github PR template, e.g. .github/pull_request_template.md",
+      "Disable with --no-template"
+    ].join(`
+`)
   },
   "write-state-json": {
     hidden: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-stack-cli",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "description": "",
   "author": "magus",
   "license": "MIT",

package/src/command.ts

@@ -79,7 +79,11 @@ const DefaultOptions = {
   "verify": {
     type: "boolean",
     default: true,
-    description: "Run git hooks such as pre-commit and pre-push, disable with --no-verify",
+    description: [
+      // force line break
+      "Run git hooks such as pre-commit and pre-push",
+      "Disable with --no-verify",
+    ].join("\n"),
   },
 
   "update": {
@@ -92,8 +96,11 @@ const DefaultOptions = {
   "branch": {
     type: "string",
     alias: ["b"],
-    description:
-      'Set the master branch name, defaults to "origin/master" (or "origin/main" if "origin/master" is not found)',
+    description: [
+      // force line break
+      "Set the master branch name, defaults to 'origin/master'",
+      "(or 'origin/main' if 'origin/master' is not found)",
+    ].join("\n"),
   },
 
   "draft": {
@@ -109,11 +116,20 @@ const DefaultOptions = {
     description: "Prefix for generated branch names, e.g. dev/magus/",
   },
 
+  "revise-sign": {
+    type: "boolean",
+    default: true,
+    description: "Disable GPG signing for git revise with --no-revise-sign",
+  },
+
   "template": {
     type: "boolean",
     default: true,
-    description:
-      "Use automatic Github PR template, e.g. .github/pull_request_template.md, disable with --no-template",
+    description: [
+      // force line break
+      "Use automatic Github PR template, e.g. .github/pull_request_template.md",
+      "Disable with --no-template",
+    ].join("\n"),
   },
 
   "write-state-json": {

package/src/core/GitReviseTodo.ts

@@ -1,6 +1,7 @@
 import fs from "node:fs/promises";
 import path from "node:path";
 
+import { Store } from "~/app/Store";
 import * as Metadata from "~/core/Metadata";
 import { cli } from "~/core/cli";
 import { get_tmp_dir } from "~/core/get_tmp_dir";
@@ -106,6 +107,9 @@ GitReviseTodo.todo = function todo(args: CommitListArgs) {
 };
 
 GitReviseTodo.execute = async function grt_execute(args: ExecuteArgs) {
+  const argv = Store.getState().argv;
+  const actions = Store.getState().actions;
+
   // replaced at build time with literal contents of `scripts/git-sequence-editor.sh`
   const GIT_SEQUENCE_EDITOR_SCRIPT = process.env.GIT_SEQUENCE_EDITOR_SCRIPT;
   invariant(GIT_SEQUENCE_EDITOR_SCRIPT, "GIT_SEQUENCE_EDITOR_SCRIPT must exist");
@@ -126,13 +130,31 @@ GitReviseTodo.execute = async function grt_execute(args: ExecuteArgs) {
     `GIT_EDITOR="${tmp_git_sequence_editor_path}"`,
     `GIT_REVISE_TODO="${tmp_path_git_revise_todo}"`,
     `git`,
-    `revise --edit -i ${args.rebase_merge_base}`,
   ];
 
-  // `ignore` hdies output which helps prevent scrollback clear
-  // `pipe` helps see failures when git revise fails
-  // https://github.com/magus/git-stack-cli/commit/f9f10e3ac3cd9a35ee75d3e0851a48391967a23f
-  await cli(command, { stdio: ["pipe", "pipe", "pipe"] });
+  if (!argv["revise-sign"]) {
+    command.push(...["-c", "commit.gpgsign=false"]);
+  }
+
+  command.push(`revise --edit -i ${args.rebase_merge_base}`);
+
+  try {
+    // `ignore` hides output which helps prevent scrollback clear
+    // `pipe` helps see failures when git revise fails
+    // https://github.com/magus/git-stack-cli/commit/f9f10e3ac3cd9a35ee75d3e0851a48391967a23f
+    await cli(command, { stdio: ["pipe", "pipe", "pipe"] });
+  } catch (err) {
+    if (err instanceof Error) {
+      actions.error(err.message);
+      if (err.message.includes("gpg failed to sign commit")) {
+        actions.error("\n\n");
+        actions.error("🚨 git revise failed to sign commit");
+        actions.error("💡 Try again with `--no-revise-sign`?");
+        actions.error("\n\n");
+        actions.exit(21);
+      }
+    }
+  }
 
   // cleanup tmp_git_sequence_editor_path
   await safe_rm(tmp_git_sequence_editor_path);