command: --label + github add labels

Author: magus

src/app/SyncGithub.tsx

@@ -28,6 +28,7 @@ async function run() {
   const master_branch = state.master_branch;
   const repo_path = state.repo_path;
   const sync_github = state.sync_github;
+  const labels = argv.label ?? [];
 
   invariant(branch_name, "branch_name must exist");
   invariant(commit_map, "commit_map must exist");
@@ -140,17 +141,17 @@ async function run() {
     const pr_url_list = all_pr_groups.map((g) => pr_url_by_group_id[g.id]);
 
     // update PR body for all pr groups (not just push_group_list)
-    const update_pr_body_tasks = [];
+    const update_pr_tasks = [];
     for (let i = 0; i < all_pr_groups.length; i++) {
       const group = all_pr_groups[i];
 
       const selected_url = pr_url_by_group_id[group.id];
 
-      const task = update_pr_body({ group, selected_url, pr_url_list });
-      update_pr_body_tasks.push(task);
+      const task = update_pr({ group, selected_url, pr_url_list, labels });
+      update_pr_tasks.push(task);
     }
 
-    await Promise.all(update_pr_body_tasks);
+    await Promise.all(update_pr_tasks);
 
     actions.unregister_abort_handler();
 
@@ -262,6 +263,7 @@ async function run() {
         title: group.title,
         body: DEFAULT_PR_BODY,
         draft: argv.draft,
+        labels,
       });
 
       if (!pr_url) {
@@ -273,10 +275,11 @@ async function run() {
     }
   }
 
-  async function update_pr_body(args: {
+  async function update_pr(args: {
     group: CommitMetadataGroup;
     selected_url: string;
     pr_url_list: Array<string>;
+    labels: Array<string>;
   }) {
     const { group, selected_url, pr_url_list } = args;
 
@@ -292,17 +295,30 @@ async function run() {
 
     const debug_meta = `${group.id} ${selected_url}`;
 
-    if (update_body === body) {
-      actions.debug(`Skipping body update ${debug_meta}`);
-    } else {
-      actions.debug(`Update body ${debug_meta}`);
+    const body_changed = update_body !== body;
+    const needs_labels = args.labels.length > 0;
 
-      await github.pr_edit({
-        branch: group.id,
-        base: group.base,
-        body: update_body,
-      });
+    if (!body_changed && !needs_labels) {
+      actions.debug(`Skipping update ${debug_meta}`);
+      return;
     }
+
+    actions.debug(`Update PR ${debug_meta}`);
+
+    const edit_args: Parameters<typeof github.pr_edit>[0] = {
+      branch: group.id,
+      base: group.base,
+    };
+
+    if (body_changed) {
+      edit_args.body = update_body;
+    }
+
+    if (needs_labels) {
+      edit_args.add_labels = args.labels;
+    }
+
+    await github.pr_edit(edit_args);
   }
 
   function is_pr_master_base(group: CommitMetadataGroup) {

src/command.ts

@@ -122,6 +122,24 @@ const DefaultOptions = {
     description: "Sync commit ranges to Github, disable with --no-sync",
   },
 
+  "label": {
+    type: "array",
+    alias: ["labels"],
+    coerce: (label_input: Array<string | number>) => label_input.map((v) => String(v)),
+    description: [
+      // force line break
+      "Apply labels to all PRs in the stack (repeatable)",
+      "Example: --label backend --label needs-review",
+    ].join("\n"),
+  },
+
+  "draft": {
+    type: "boolean",
+    alias: ["d"],
+    default: false,
+    description: "Open all PRs as drafts",
+  },
+
   "verify": {
     type: "boolean",
     default: true,
@@ -142,19 +160,6 @@ const DefaultOptions = {
     ].join("\n"),
   },
 
-  "draft": {
-    type: "boolean",
-    alias: ["d"],
-    default: false,
-    description: "Open all PRs as drafts",
-  },
-
-  "revise-sign": {
-    type: "boolean",
-    default: true,
-    description: "Disable GPG signing for git revise with --no-revise-sign",
-  },
-
   "template": {
     type: "boolean",
     default: true,
@@ -164,6 +169,12 @@ const DefaultOptions = {
       "Disable with --no-template",
     ].join("\n"),
   },
+
+  "revise-sign": {
+    type: "boolean",
+    default: true,
+    description: "Disable GPG signing for git revise with --no-revise-sign",
+  },
 } satisfies YargsOptions;
 
 const FixupOptions = {

src/core/github.tsx

@@ -121,6 +121,7 @@ type CreatePullRequestArgs = {
   title: string;
   body: string;
   draft: boolean;
+  labels?: Array<string>;
 };
 
 export async function pr_create(args: CreatePullRequestArgs) {
@@ -147,6 +148,13 @@ export async function pr_create(args: CreatePullRequestArgs) {
     command_parts.push("--draft");
   }
 
+  if (args.labels && args.labels.length > 0) {
+    for (const label of args.labels) {
+      if (!label) continue;
+      command_parts.push(`--label="${safe_quote(label)}"`);
+    }
+  }
+
   const cli_result = await cli(command_parts);
 
   if (cli_result.code !== 0) {
@@ -161,14 +169,17 @@ type EditPullRequestArgs = {
   branch: string;
   base?: string;
   body?: string;
+  add_labels?: Array<string>;
 };
 
 export async function pr_edit(args: EditPullRequestArgs) {
+  // https://cli.github.com/manual/gh_pr_edit
+
   // const state = Store.getState();
   // const actions = state.actions;
   // actions.debug(`github.pr_edit ${JSON.stringify(args)}`);
 
-  if (!args.base && !args.body) {
+  if (!args.base && !args.body && !(args.add_labels && args.add_labels.length > 0)) {
     return;
   }
 
@@ -186,6 +197,13 @@ export async function pr_edit(args: EditPullRequestArgs) {
     command_parts.push(`--body-file="${body_file}"`);
   }
 
+  if (args.add_labels && args.add_labels.length > 0) {
+    for (const label of args.add_labels) {
+      if (!label) continue;
+      command_parts.push(`--add-label="${safe_quote(label)}"`);
+    }
+  }
+
   const cli_result = await cli(command_parts);
 
   if (cli_result.code !== 0) {