git-stack-cli 1.11.1 → 1.11.3

package/README.md

@@ -13,7 +13,7 @@
 
 ## Demo
 
-> <img src="https://github.com/magus/git-multi-diff-playground/assets/290084/069c304b-80cb-49a9-9dc6-4ed3b061a5bc">
+> <img alt="git stack demo" src="https://github.com/magus/git-multi-diff-playground/assets/290084/069c304b-80cb-49a9-9dc6-4ed3b061a5bc">
 
 ## Install
 
@@ -54,6 +54,25 @@ git stack --no-verify # skip git hooks such as pre-commit and pre-push
 git stack help        # print a table of all CLI arguments
 ```
 
+### Editing existing commits and pull requests
+
+Sometimes you want to add changes to an existing commit or pull request.
+With `git-stack` this is as simple as amending the commit.
+
+1. `git add` your changes to the stage
+2. `git stack log` to find the relative commit number you want to amend
+3. `git stack fixup <number>` to amend the specific commit with your staged changes.
+
+```bash
+git add -p
+git stack log
+git stack fixup 2
+```
+
+> <img alt="git stack fixup demo" src="https://github.com/user-attachments/assets/2cdfaa5b-00be-4ed3-8bed-4a24c412979b">
+
+Running `git stack` afterward will update any existing pull requests with your changes.
+
 ## Why?
 
 The goal of `git stack` is to combine the **simplicity of developing in a single branch** in order to **preserve your commit history** while also **grouping commits into pull requests for code review**.

package/dist/cjs/index.cjs

@@ -29774,9 +29774,12 @@ async function pr_create(args) {
     return cli_result.stdout;
 }
 async function pr_edit(args) {
-    const cli_result = await cli(
-    // prettier-ignore
-    `gh pr edit ${args.branch} --base ${args.base} --body-file="${body_file(args.body)}"`);
+    const command_parts = [`gh pr edit ${args.branch} --base ${args.base}`];
+    if (args.body) {
+        command_parts.push(`--body-file="${body_file(args.body)}"`);
+    }
+    const command = command_parts.join(" ");
+    const cli_result = await cli(command);
     if (cli_result.code !== 0) {
         handle_error(cli_result.output);
     }
@@ -30056,6 +30059,45 @@ GitReviseTodo.todo = function todo(args) {
 GitReviseTodo.execute = async function grt_execute(args) {
     // generate temporary directory and drop sequence editor script
     const tmp_git_sequence_editor_path = path.join(os.tmpdir(), "git-sequence-editor.sh");
+    // replaced at build time with literal contents of `scripts/git-sequence-editor.sh`
+    const GIT_SEQUENCE_EDITOR_SCRIPT = `#!/bin/sh
+
+# Example
+#
+#   GIT_REVISE_TODO="abc" GIT_EDITOR="$(pwd)/scripts/git-sequence-editor.sh" git revise --edit -i head~4
+#
+#   Note
+#   ----------------
+#   Use \`GIT_EDITOR\` above instead of \`GIT_SEQUENCE_EDITOR\` because \`git revise\` does not use
+#   \`GIT_SEQUENCE_EDITOR\` when passing the \`--edit\` flag, but does work without the \`--edit\` flag
+#
+#
+
+# debug print env variables
+echo "GIT_REVISE_TODO=$GIT_REVISE_TODO"
+echo "CLI=$0 $*"
+echo "PWD=$(pwd)"
+
+# ensure \`GIT_REVISE_TODO\` is not empty
+if [ -z "$GIT_REVISE_TODO" ]; then
+  echo "🚨 GIT_REVISE_TODO environment variable is empty" >&2
+  exit 1
+fi
+
+# first argument into git sequence editor is git-revise-todo file
+git_revise_todo_path="$1"
+
+# debug print git-revise-todo file passed into command
+echo "$git_revise_todo_path"
+echo "----- START -----"
+cat "$git_revise_todo_path"
+echo "------ END ------"
+
+# write content of \`GIT_REVISE_TODO\` env variable to \`git_revise_todo_path\`
+echo "$GIT_REVISE_TODO" > "$git_revise_todo_path"
+`;
+    // write script to temporary path
+    fs.writeFileSync(tmp_git_sequence_editor_path, GIT_SEQUENCE_EDITOR_SCRIPT);
     // ensure script is executable
     fs.chmodSync(tmp_git_sequence_editor_path, "755");
     const git_revise_todo = GitReviseTodo(args);
@@ -30778,50 +30820,6 @@ async function run$5() {
     async function rebase_git_revise() {
         actions.debug(`rebase_git_revise`);
         actions.output(reactExports.createElement(Text, { color: colors.yellow, wrap: "truncate-end" }, "Rebasing\u2026"));
-        // generate temporary directory and drop sequence editor script
-        const tmp_git_sequence_editor_path = path.join(os.tmpdir(), "git-sequence-editor.sh");
-        actions.debug(`tmp_git_sequence_editor_path=${tmp_git_sequence_editor_path}`);
-        // replaced at build time with literal contents of `scripts/git-sequence-editor.sh`
-        const GIT_SEQUENCE_EDITOR_SCRIPT = `#!/bin/sh
-
-# Example
-#
-#   GIT_REVISE_TODO="abc" GIT_EDITOR="$(pwd)/scripts/git-sequence-editor.sh" git revise --edit -i head~4
-#
-#   Note
-#   ----------------
-#   Use \`GIT_EDITOR\` above instead of \`GIT_SEQUENCE_EDITOR\` because \`git revise\` does not use
-#   \`GIT_SEQUENCE_EDITOR\` when passing the \`--edit\` flag, but does work without the \`--edit\` flag
-#
-#
-
-# debug print env variables
-echo "GIT_REVISE_TODO=$GIT_REVISE_TODO"
-echo "CLI=$0 $*"
-echo "PWD=$(pwd)"
-
-# ensure \`GIT_REVISE_TODO\` is not empty
-if [ -z "$GIT_REVISE_TODO" ]; then
-  echo "🚨 GIT_REVISE_TODO environment variable is empty" >&2
-  exit 1
-fi
-
-# first argument into git sequence editor is git-revise-todo file
-git_revise_todo_path="$1"
-
-# debug print git-revise-todo file passed into command
-echo "$git_revise_todo_path"
-echo "----- START -----"
-cat "$git_revise_todo_path"
-echo "------ END ------"
-
-# write content of \`GIT_REVISE_TODO\` env variable to \`git_revise_todo_path\`
-echo "$GIT_REVISE_TODO" > "$git_revise_todo_path"
-`;
-        // write script to temporary path
-        fs.writeFileSync(tmp_git_sequence_editor_path, GIT_SEQUENCE_EDITOR_SCRIPT);
-        // ensure script is executable
-        fs.chmodSync(tmp_git_sequence_editor_path, "755");
         // create temporary branch
         await cli(`git checkout -b ${temp_branch_name}`);
         await GitReviseTodo.execute({
@@ -30913,6 +30911,15 @@ echo "$GIT_REVISE_TODO" > "$git_revise_todo_path"
         actions.output(reactExports.createElement(FormatText, { wrapper: reactExports.createElement(Text, { color: colors.yellow, wrap: "truncate-end" }), message: "Syncing {group}\u2026", values: {
                 group: (reactExports.createElement(Brackets, null, group.pr?.title || group.title || group.id)),
             } }));
+        // before pushing reset base to master temporarily
+        // avoid accidentally pointing to orphaned parent commit
+        // should hopefully fix issues where a PR includes a bunch of commits after pushing
+        if (group.pr) {
+            await pr_edit({
+                branch: group.id,
+                base: master_branch,
+            });
+        }
         // push to origin since github requires commit shas to line up perfectly
         const git_push_command = [`git push -f origin HEAD:${group.id}`];
         if (argv.verify === false) {
@@ -37385,7 +37392,7 @@ async function command() {
         .wrap(123)
         // disallow unknown options
         .strict()
-        .version("1.11.1" )
+        .version("1.11.3" )
         .showHidden("show-hidden", "Show hidden options via `git stack help --show-hidden`")
         .help("help", "Show usage via `git stack help`")
         .argv;

package/package.json

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

package/scripts/release-npm.ts

@@ -17,6 +17,13 @@ await fs.mkdir(DIST_DIR, { recursive: true });
 
 process.chdir(PROJECT_DIR);
 
+// require clean git status besides changes to package.json version
+const git_status = await spawn.sync("git status --porcelain");
+if (!/^M\s+package.json/.test(git_status.stdout)) {
+  console.error("please commit local changes before running release");
+  process.exit(4);
+}
+
 const package_json = await file.read_json(
   path.join(PROJECT_DIR, "package.json")
 );

package/src/app/ManualRebase.tsx

@@ -1,8 +1,6 @@
 import * as React from "react";
 
 import fs from "node:fs";
-import os from "node:os";
-import path from "node:path";
 
 import * as Ink from "ink-cjs";
 import cloneDeep from "lodash/cloneDeep";
@@ -145,25 +143,6 @@ async function run() {
       </Ink.Text>
     );
 
-    // generate temporary directory and drop sequence editor script
-    const tmp_git_sequence_editor_path = path.join(
-      os.tmpdir(),
-      "git-sequence-editor.sh"
-    );
-
-    actions.debug(
-      `tmp_git_sequence_editor_path=${tmp_git_sequence_editor_path}`
-    );
-
-    // replaced at build time with literal contents of `scripts/git-sequence-editor.sh`
-    const GIT_SEQUENCE_EDITOR_SCRIPT = `process.env.GIT_SEQUENCE_EDITOR_SCRIPT`;
-
-    // write script to temporary path
-    fs.writeFileSync(tmp_git_sequence_editor_path, GIT_SEQUENCE_EDITOR_SCRIPT);
-
-    // ensure script is executable
-    fs.chmodSync(tmp_git_sequence_editor_path, "755");
-
     // create temporary branch
     await cli(`git checkout -b ${temp_branch_name}`);
 
@@ -310,6 +289,16 @@ async function run() {
       />
     );
 
+    // before pushing reset base to master temporarily
+    // avoid accidentally pointing to orphaned parent commit
+    // should hopefully fix issues where a PR includes a bunch of commits after pushing
+    if (group.pr) {
+      await github.pr_edit({
+        branch: group.id,
+        base: master_branch,
+      });
+    }
+
     // push to origin since github requires commit shas to line up perfectly
     const git_push_command = [`git push -f origin HEAD:${group.id}`];
 

package/src/core/GitReviseTodo.ts

@@ -116,6 +116,12 @@ GitReviseTodo.execute = async function grt_execute(args: ExecuteArgs) {
     "git-sequence-editor.sh"
   );
 
+  // replaced at build time with literal contents of `scripts/git-sequence-editor.sh`
+  const GIT_SEQUENCE_EDITOR_SCRIPT = `process.env.GIT_SEQUENCE_EDITOR_SCRIPT`;
+
+  // write script to temporary path
+  fs.writeFileSync(tmp_git_sequence_editor_path, GIT_SEQUENCE_EDITOR_SCRIPT);
+
   // ensure script is executable
   fs.chmodSync(tmp_git_sequence_editor_path, "755");
 

package/src/core/github.tsx

@@ -141,14 +141,19 @@ export async function pr_create(args: CreatePullRequestArgs) {
 type EditPullRequestArgs = {
   branch: string;
   base: string;
-  body: string;
+  body?: string;
 };
 
 export async function pr_edit(args: EditPullRequestArgs) {
-  const cli_result = await cli(
-    // prettier-ignore
-    `gh pr edit ${args.branch} --base ${args.base} --body-file="${body_file(args.body)}"`
-  );
+  const command_parts = [`gh pr edit ${args.branch} --base ${args.base}`];
+
+  if (args.body) {
+    command_parts.push(`--body-file="${body_file(args.body)}"`);
+  }
+
+  const command = command_parts.join(" ");
+
+  const cli_result = await cli(command);
 
   if (cli_result.code !== 0) {
     handle_error(cli_result.output);