Merge pull request #9 from mheap/dry-run

Author: mheap

README.md

@@ -43,12 +43,14 @@ Run with the `--verbose` flag to see debug information
 
 ## Options
 
-| Flag          | Description                                                    | Default |
-| ------------- | -------------------------------------------------------------- | ------- |
-| --pat <token> | GitHub API Token                                               | N/A     |
-| --repo <name> | The repo to update (format: user/repo)                         | N/A     |
-| --user <name> | Update all repos owned by the provided user (example: my-user) | N/A     |
-| --org <name>  | Update all repos in the provided org (example: my-org-name)    | N/A     |
-| --keep-old    | Keep the old branch rather than deleting it                    | false   |
-| --old         | The name of the branch to rename                               | master  |
-| --new         | The new branch name                                            | main    |
+| Flag              | Description                                                    | Default |
+| ----------------- | -------------------------------------------------------------- | ------- |
+| --pat <token>     | GitHub API Token                                               | N/A     |
+| --repo <name>     | The repo to update (format: user/repo)                         | N/A     |
+| --user <name>     | Update all repos owned by the provided user (example: my-user) | N/A     |
+| --org <name>      | Update all repos in the provided org (example: my-org-name)    | N/A     |
+| --keep-old        | Keep the old branch rather than deleting it                    | false   |
+| --dry-run         | Output log messages only. Do not make any changes              | false   |
+| --list-repos-only | List repos that would be affected, then exit                   | false   |
+| --old             | The name of the branch to rename                               | master  |
+| --new             | The new branch name                                            | main    |

bin/github-default-branch

@@ -2,6 +2,13 @@
 (async function () {
   const { argv } = require("yargs");
 
+  const isDryRun = !!argv.dryRun;
+
+  // Force verbose output in dry run mode
+  if (isDryRun) {
+    argv.verbose = true;
+  }
+
   // Up front validation
   const providedRepoSelectors = [argv.org, argv.user, argv.repo].filter(
     (v) => v
@@ -41,11 +48,16 @@
         rate: { remaining },
       },
     } = await octokit.rateLimit.get();
-    console.log(`You have ${remaining} API requests remaining`);
+    console.log(`You have ${remaining} API requests remaining\n`);
   }
 
   const repos = await getRepos(argv, octokit);
 
+  if (argv.listReposOnly) {
+    console.log(repos.join("\n"));
+    return;
+  }
+
   const old = argv.old || "master";
   const target = argv.new || "main";
 
@@ -56,13 +68,20 @@
 
     const [owner, repo] = r.split("/", 2);
     const currentMasterSha = await getBranchSha(owner, repo, old, octokit);
-    const mainBranch = await createBranch(
-      owner,
-      repo,
-      target,
-      currentMasterSha,
-      octokit
-    );
+
+    if (argv.verbose) {
+      console.log(`✏️  Creating branch [${target}] at [${currentMasterSha}]`);
+    }
+
+    if (!isDryRun) {
+      const mainBranch = await createBranch(
+        owner,
+        repo,
+        target,
+        currentMasterSha,
+        octokit
+      );
+    }
 
     // List all PRs
     let pulls = await octokit.paginate(
@@ -82,24 +101,49 @@
         continue;
       }
 
-      await octokit.pulls.update({
+      if (argv.verbose) {
+        console.log(
+          `✏️  Updating pull request [#${pr.number}] in [${repo}] from [${pr.base.ref}] to [${target}]`
+        );
+      }
+
+      if (!isDryRun) {
+        await octokit.pulls.update({
+          owner,
+          repo,
+          pull_number: pr.number,
+          base: target,
+        });
+      }
+    }
+
+    if (argv.verbose) {
+      console.log(`✏️  Updating default branch to [${target}] in [${repo}]`);
+    }
+
+    if (!isDryRun) {
+      // Update the default branch in the repo
+      await octokit.repos.update({
         owner,
         repo,
-        pull_number: pr.number,
-        base: target,
+        default_branch: target,
       });
     }
 
-    // Update the default branch in the repo
-    await octokit.repos.update({
-      owner,
-      repo,
-      default_branch: target,
-    });
+    if (argv.verbose) {
+      console.log(`✏️  Deleting old branch [${old}] in ${repo}`);
+    }
 
-    // Remove old branch if required
-    if (!argv.keepOld) {
-      await removeBranch(owner, repo, old, octokit);
+    if (!isDryRun) {
+      // Remove old branch if required
+      if (!argv.keepOld) {
+        await removeBranch(owner, repo, old, octokit);
+      }
+    }
+
+    // Add an empty new line to break up the output for each repo
+    if (argv.verbose) {
+      console.log("");
     }
   }