Initial Commit

Author: mheap

.gitignore

@@ -0,0 +1,116 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

LICENSE

@@ -0,0 +1,21 @@
+MIT License Copyright (c) 2020 Michael Heap
+
+Permission is hereby granted, free
+of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice
+(including the next paragraph) shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,51 @@
+# GitHub Default Branch
+
+Rename your default branch on GitHub easily. By default it renames `master` to `main`, but is configurable using the `--new` and `--old` flags.
+
+If provided with an `--org` argument, it will run on all repositories within that organisation. Alternatively, you can provide a `--repo` argument to edit a single repo.
+
+For each repo, this tool will:
+
+- Create a new branch at the same commit SHA as the old one
+- Update all open pull requests to point at the new branch
+- Update the default branch for the repo
+- Delete the old branch
+
+## Installation
+
+```bash
+npm install -g github-default-branch
+```
+
+## Authentication
+
+[Create a personal access token](https://github.com/settings/tokens/new) with the `repo` scope. This is the value for `<token>` in the examples
+
+## Usage
+
+```
+# Rename master to main
+github-default-branch --pat <token> --repo user/repo
+
+# Rename dev to develop
+github-default-branch --pat <token> --repo user/repo --old dev --new develop
+```
+
+Run with the `--verbose` flag to see debug information
+
+## Options
+
+| Flag          | Description                      | Default |
+| ------------- | -------------------------------- | ------- |
+| --pat <token> | GitHub API Token                 | N/A     |
+| --repo <name> | user/repo                        | N/A     |
+| --org <name>  | my-org-name                      | N/A     |
+| --keep-old    |                                  | false   |
+| --old         | The name of the branch to rename | master  |
+| --new         | The new branch name              | main    |
+
+## Enhancements
+
+- Error if the target branch already exists
+- `--visibility` flag (`all`, `public`, `private`). Default `all`
+- Copy branch protections from the old branch to the new one

bin/github-default-branch

@@ -0,0 +1,103 @@
+#!/usr/bin/env node
+(async function () {
+  const { argv } = require("yargs");
+
+  // Up front validation
+  if (!argv.org && !argv.repo) {
+    console.log("❎ You must provide --org or --repo");
+    return;
+  }
+
+  if (argv.org && argv.repo) {
+    console.log("❎ Only --org OR --repo is supported");
+    return;
+  }
+
+  if (!argv.pat && !process.env.GITHUB_TOKEN) {
+    console.log(
+      "❎ Provide a GitHub Access Token using --pat <token> or using the GITHUB_TOKEN environment variable"
+    );
+    return;
+  }
+
+  const { Octokit } = require("@octokit/rest");
+
+  const getRepos = require("../src/get-repos");
+  const getBranchSha = require("../src/get-branch-sha");
+  const createBranch = require("../src/create-branch");
+  const removeBranch = require("../src/remove-branch");
+
+  const octokit = new Octokit({
+    auth: argv.pat || process.env.GITHUB_TOKEN,
+  });
+
+  if (argv.verbose) {
+    const {
+      data: {
+        rate: { remaining },
+      },
+    } = await octokit.rateLimit.get();
+    console.log(`You have ${remaining} API requests remaining`);
+  }
+
+  const repos = await getRepos(argv, octokit);
+
+  const old = argv.old || "master";
+  const target = argv.new || "main";
+
+  for (let r of repos) {
+    if (argv.verbose) {
+      console.log(`✏️  Processing ${r}`);
+    }
+
+    const [owner, repo] = r.split("/", 2);
+    const currentMasterSha = await getBranchSha(owner, repo, old, octokit);
+    const mainBranch = await createBranch(
+      owner,
+      repo,
+      target,
+      currentMasterSha,
+      octokit
+    );
+
+    // List all PRs
+    let pulls = await octokit.paginate(
+      "GET /repos/:owner/:repo/pulls",
+      {
+        owner,
+        repo,
+        state: "open",
+        per_page: 100,
+      },
+      (response) => response.data
+    );
+
+    // Update the target branch for all open PRs
+    for (let pr of pulls) {
+      if (pr.base.ref != old) {
+        continue;
+      }
+
+      await octokit.pulls.update({
+        owner,
+        repo,
+        pull_number: pr.number,
+        base: target,
+      });
+    }
+
+    // Update the default branch in the repo
+    await octokit.repos.update({
+      owner,
+      repo,
+      default_branch: target,
+    });
+
+    // Remove old branch if required
+    if (!argv.keepOld) {
+      await removeBranch(owner, repo, old, octokit);
+    }
+  }
+
+  console.log("✅ Complete");
+})();