bstack 0.2.2 → 0.3.0

package/README.md

@@ -1,22 +1,23 @@
 # bstack
 
-`bstack` turns a series of commits on a local branch into native GitHub stacked pull requests.
+Convert series of commits in a local branch into native GitHub stacked pull requests.
 
 ## Install
 
-Requirements:
+```bash
+npm install -g bstack
+```
 
-- Node.js 20+
-- `gh cli` plus the `github/gh-stack` extension (authenticated)
+Install and authenticate the GitHub CLI with the `github/gh-stack` extension:
 
-```bash
+```
+gh auth login
 gh extension install github/gh-stack
-npm install bstack -g
 ```
 
 ## Use
 
-Create one commit per reviewable change, then publish the stack:
+Create one commit per change, then publish the stack:
 
 ```bash
 git switch -c my-feature
@@ -25,7 +26,9 @@ git commit -am "feat: add the API"
 bstack
 ```
 
-Run `bstack` again after amending or rebasing commits. New PRs are drafts unless you pass `--open`.
+Run `bstack` again after amending or rebasing commits.
+
+New PRs are ready for review by default. Pass `--draft` to create draft PRs.
 
 Checkout a stack through one of its PRs:
 
@@ -34,24 +37,9 @@ bstack checkout 123
 bstack checkout https://github.com/owner/repo/pull/123
 ```
 
-The first publish adds a stable `Bstack-Id` trailer to each commit and rewrites their hashes. The working tree must be clean. Merge commits and signed commits that need trailers are not supported.
-
 Use `--dry-run` to inspect without publishing and `--quiet` to hide progress logs.
 
-## Develop
-
-Install dependencies and run the checks with pnpm:
+## References
 
-```bash
-pnpm install
-pnpm run type-check
-pnpm test
-pnpm run lint
-```
-
-Build the Node.js CLI with tsdown:
-
-```bash
-pnpm run build
-node dist/bstack.js --help
-```
+- [ezyang/ghstack](https://github.com/ezyang/ghstack)
+- [github/gh-stack](https://github.com/github/gh-stack)

package/dist/bstack.js

@@ -5,7 +5,7 @@ import { randomUUID } from "node:crypto";
 import { mkdirSync, readFileSync, renameSync, writeFileSync } from "node:fs";
 import { dirname } from "node:path";
 //#region package.json
-var version = "0.2.2";
+var version = "0.3.0";
 //#endregion
 //#region src/command.ts
 var CommandError = class extends Error {
@@ -368,7 +368,7 @@ var GhPlatform = class {
 		]).stdout;
 		return normalizePullRequest(JSON.parse(raw));
 	}
-	createPullRequest(change, base, open) {
+	createPullRequest(change, base, draft) {
 		const args = [
 			"pr",
 			"create",
@@ -381,13 +381,13 @@ var GhPlatform = class {
 			"--body",
 			change.body
 		];
-		if (!open) args.push("--draft");
+		if (draft) args.push("--draft");
 		this.gh(args);
 		const created = this.pullRequestForBranch(change.remoteBranch);
 		if (!created) throw new Error(`GitHub did not return the PR created for ${change.remoteBranch}`);
 		return created;
 	}
-	linkStack(branches, base, remote, open) {
+	linkStack(branches, base, remote, draft) {
 		const args = [
 			"stack",
 			"link",
@@ -396,18 +396,18 @@ var GhPlatform = class {
 			"--remote",
 			remote
 		];
-		if (open) args.push("--open");
+		if (!draft) args.push("--open");
 		args.push(...branches);
 		this.gh(args);
 	}
-	appendToStack(stackNumber, branches, remote, open) {
+	appendToStack(stackNumber, branches, remote, draft) {
 		const args = [
 			"stack",
 			"link",
 			"--remote",
 			remote
 		];
-		if (open) args.push("--open");
+		if (!draft) args.push("--open");
 		args.push(String(stackNumber), ...branches);
 		this.gh(args);
 	}
@@ -554,20 +554,20 @@ function syncStack(repository, github, options) {
 	if (changes.length === 1) {
 		if (evolution.kind === "partial") reporter.progress("Updating this down-stack prefix while preserving higher pull requests");
 		reporter.progress(existing[0] ? "Using the existing pull request" : "Creating a pull request");
-		pullRequests = [existing[0] ?? github.createPullRequest(changes[0], base, options.open)];
+		pullRequests = [existing[0] ?? github.createPullRequest(changes[0], base, options.draft)];
 	} else {
 		if (evolution.kind === "full") {
 			reporter.progress(`Linking ${changes.length} pull requests as a native GitHub stack`);
-			github.linkStack(changes.map((change) => change.remoteBranch), base, remote, options.open);
+			github.linkStack(changes.map((change) => change.remoteBranch), base, remote, options.draft);
 		} else if (evolution.kind === "rebuild") {
 			reporter.progress(`Rebuilding stack #${evolution.stackNumber} to insert pull requests`);
 			github.unstack(evolution.stackNumber);
 			try {
-				github.linkStack(changes.map((change) => change.remoteBranch), base, remote, options.open);
+				github.linkStack(changes.map((change) => change.remoteBranch), base, remote, options.draft);
 			} catch (error) {
 				reporter.progress("Rebuild failed; restoring the previous native GitHub stack");
 				try {
-					github.linkStack(previous.changes.map((change) => change.remoteBranch), base, remote, false);
+					github.linkStack(previous.changes.map((change) => change.remoteBranch), base, remote, true);
 				} catch (rollbackError) {
 					throw new Error(`Stack rebuild failed: ${errorMessage(error)}\nRestoring the previous stack also failed: ${errorMessage(rollbackError)}`);
 				}
@@ -575,7 +575,7 @@ function syncStack(repository, github, options) {
 			}
 		} else if (evolution.kind === "append") {
 			reporter.progress(`Appending ${evolution.branches.length} pull request${evolution.branches.length === 1 ? "" : "s"} to stack #${evolution.stackNumber}`);
-			github.appendToStack(evolution.stackNumber, evolution.branches, remote, options.open);
+			github.appendToStack(evolution.stackNumber, evolution.branches, remote, options.draft);
 		} else if (evolution.kind === "partial") reporter.progress("Updating this down-stack prefix while preserving higher pull requests");
 		else reporter.progress("The native GitHub stack already has the correct members");
 		pullRequests = changes.map((change, index) => {
@@ -673,7 +673,7 @@ Usage:
 Options:
   --base <branch>    Stack trunk; defaults to the GitHub default branch
   --remote <name>    Git remote; defaults to remote.pushDefault or origin
-  --open             Create PRs ready for review instead of drafts
+  --draft            Create draft PRs instead of ready-for-review PRs
   --dry-run          Inspect the stack without rewriting commits or pushing
   --quiet            Hide progress logs; the final summary is still printed
   --same-base        Refuse checkout if it would change the current merge base
@@ -687,7 +687,7 @@ function main() {
 		options: {
 			base: { type: "string" },
 			remote: { type: "string" },
-			open: {
+			draft: {
 				type: "boolean",
 				default: false
 			},
@@ -746,7 +746,7 @@ function main() {
 	const result = syncStack(repository, github, {
 		base: values.base,
 		remote: values.remote,
-		open: values.open,
+		draft: values.draft,
 		dryRun: values["dry-run"],
 		reporter
 	});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bstack",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "packageManager": "pnpm@11.5.1",
   "description": "Create native GitHub stacked pull requests from a linear series of commits",
   "repository": {