use main branch if it exists

docs/pages/docs/configuration/autorc.mdx

@@ -38,6 +38,7 @@ Configure the default release behavior.
 ### Base Branch
 
 Configure what your repo considers the base branch.
+Defaults to either `main` or `master`.
 
 ```json
 {

docs/pages/docs/extras/shipit.md

@@ -42,8 +42,8 @@ Read more about preparing you project for pre-releases [here](./next#setting-up-
 
 #### "next" Branch (default)
 
-The suggested way to create pre-releases is by managing 2 branches for your repo: `master` and `next`.
-`master` contains the `latest` stable version of the code, and `next` contains future updates.
+The suggested way to create pre-releases is by managing 2 branches for your repo: `baseBranch` and `next`.
+`baseBranch` contains the `latest` stable version of the code, and `next` contains future updates.
 
 You can change what branches `auto` treats as pre-release branches in your [`.autorc`](../configuration/autorc#prerelease-branches).
 

packages/cli/src/parse-args.ts

@@ -129,7 +129,7 @@ const defaultOptions: AutoOption[] = [
 const baseBranch: AutoOption = {
   name: "base-branch",
   type: String,
-  description: 'Branch to treat as the "master" branch',
+  description: "Branch to treat as the base branch",
   group: "global",
 };
 
@@ -515,7 +515,7 @@ export const commands: AutoCommand[] = [
         defaultValue: false,
         group: "main",
         description:
-          'Make auto publish prerelease versions when merging to master. Only PRs merged with "release" label will generate a "latest" release. Only use this flag if you do not want to maintain a prerelease branch, and instead only want to use master.',
+          'Make auto publish prerelease versions when merging to baseBranch. Only PRs merged with "release" label will generate a "latest" release. Only use this flag if you do not want to maintain a prerelease branch, and instead only want to use baseBranch.',
         config: true,
       },
     ],

packages/core/src/__tests__/__snapshots__/auto.test.ts.snap

@@ -84,7 +84,7 @@ exports[`Auto createLabels should create the labels 1`] = `
 
 exports[`Auto should extend config 1`] = `
 Object {
-  "baseBranch": "master",
+  "baseBranch": "main",
   "extends": "@artsy/auto-config/package.json",
   "labels": Array [
     Object {
@@ -171,7 +171,7 @@ Object {
 
 exports[`Auto should extend local config 1`] = `
 Object {
-  "baseBranch": "master",
+  "baseBranch": "main",
   "extends": "<PROJECT_ROOT>fake.json",
   "labels": Array [
     Object {

packages/core/src/__tests__/__snapshots__/changelog.test.ts.snap

@@ -78,7 +78,7 @@ exports[`generateReleaseNotes should add "Push to Next" 1`] = `
 
 #### ⚠️ Pushed to \`next\`
 
-- I was a push to master ([email protected])
+- I was a push to main ([email protected])
 
 #### Authors: 1
 
@@ -110,7 +110,7 @@ exports[`generateReleaseNotes should be able to customize pushToBaseBranch title
 
 #### Custom Title
 
-- I was a push to master ([email protected])
+- I was a push to main ([email protected])
 
 #### Authors: 1
 
@@ -183,9 +183,9 @@ exports[`generateReleaseNotes should include PR-less commits as patches 1`] = `
 
 - First Feature [#1235](https://github.custom.com/foobar/auto/pull/1235) ([email protected])
 
-#### ⚠️ Pushed to \`master\`
+#### ⚠️ Pushed to \`main\`
 
-- I was a push to master ([email protected])
+- I was a push to main ([email protected])
 
 #### Authors: 1
 
@@ -195,7 +195,7 @@ exports[`generateReleaseNotes should include PR-less commits as patches 1`] = `
 exports[`generateReleaseNotes should include PR-less commits as the default label 1`] = `
 "#### 🚀 Enhancement
 
-- I was a push to master ([email protected])
+- I was a push to main ([email protected])
 - First Feature [#1235](https://github.custom.com/foobar/auto/pull/1235) ([email protected])
 
 #### Authors: 1
@@ -298,7 +298,7 @@ exports[`generateReleaseNotes should order the section major, minor, patch, then
 
 #### 🐛 Bug Fix
 
-- I was a push to master ([email protected])
+- I was a push to main ([email protected])
 
 #### 📝 Documentation
 

packages/core/src/__tests__/__snapshots__/release.test.ts.snap

@@ -76,7 +76,7 @@ exports[`Release generateReleaseNotes should include PR-less commits 1`] = `
 
 - First Feature [#1235](https://github.com/web/site/pull/1235) ([email protected])
 
-#### ⚠️ Pushed to \`master\`
+#### ⚠️ Pushed to \`main\`
 
 - I should be included ([email protected])
 
@@ -116,9 +116,9 @@ exports[`Release generateReleaseNotes should match rebased commits to PRs 1`] =
 - Feature [#124](https://github.com/web/site/pull/124) ([email protected])
 - I was rebased [#123](https://github.com/web/site/pull/123) ([email protected])
 
-#### ⚠️ Pushed to \`master\`
+#### ⚠️ Pushed to \`main\`
 
-- I am a commit to master ([email protected])
+- I am a commit to main ([email protected])
 
 #### Authors: 1
 

packages/core/src/__tests__/auto-canary-local.test.ts

@@ -31,7 +31,7 @@ jest.mock("@octokit/rest", () => {
   return { Octokit };
 });
 
-test("shipit should publish canary in locally when not on master", async () => {
+test("shipit should publish canary in locally when not on baseBranch", async () => {
   const auto = new Auto({ ...defaults, plugins: [] });
   auto.logger = dummyLog();
   // @ts-ignore

packages/core/src/__tests__/auto-ci-base-branch.test.ts

@@ -6,12 +6,13 @@ jest.mock("env-ci");
 const envSpy = envCi as jest.Mock;
 envSpy.mockImplementation(() => ({
   isCi: true,
-  branch: "master",
+  branch: "main",
 }));
 
 import { Auto } from "../auto";
 
 const defaults = {
+  baseBranch: "main",
   owner: "foo",
   repo: "bar",
 };
@@ -51,13 +52,13 @@ describe("Auto", () => {
       url: "https://google.com",
     };
 
-    test("should exit successfully if ran from master + CI", async () => {
+    test("should exit successfully if ran from main + CI", async () => {
       const auto = new Auto(defaults);
       const exit = jest.fn();
 
       envSpy.mockImplementationOnce(() => ({
         isCi: true,
-        branch: "master",
+        branch: "main",
       }));
 
       // @ts-ignore

packages/core/src/__tests__/auto-make-changelog.test.ts

@@ -10,7 +10,7 @@ jest
 
 const importMock = jest.fn();
 jest.mock("import-cwd", () => (path: string) => importMock(path));
-jest.mock("env-ci", () => () => ({ isCi: false, branch: "master" }));
+jest.mock("env-ci", () => () => ({ isCi: false, branch: "main" }));
 jest.mock("../utils/exec-promise", () => () => Promise.resolve(""));
 
 const defaults = {

packages/core/src/__tests__/auto.test.ts

@@ -5,16 +5,24 @@ import { dummyLog } from "../utils/logger";
 import makeCommitFromMsg from "./make-commit-from-msg";
 import { loadPlugin } from "../utils/load-plugins";
 import child from "child_process";
+import execPromise from "../utils/exec-promise";
+
+const exec = jest.fn();
+jest.mock("../utils/exec-promise");
+// @ts-ignore
+execPromise.mockImplementation(exec);
+exec.mockResolvedValue("");
 
 const importMock = jest.fn();
 
 jest.mock("../utils/git-reset.ts");
 jest.mock("../utils/load-plugins.ts");
 jest.mock("../utils/verify-auth.ts", () => () => true);
 jest.mock("import-cwd", () => (path: string) => importMock(path));
-jest.mock("env-ci", () => () => ({ isCi: false, branch: "master" }));
+jest.mock("env-ci", () => () => ({ isCi: false, branch: "main" }));
 
 const defaults = {
+  baseBranch: "main",
   owner: "foo",
   repo: "bar",
 };
@@ -114,7 +122,7 @@ describe("Auto", () => {
     const auto = new Auto();
     auto.logger = dummyLog();
     await auto.loadConfig();
-    expect(auto.baseBranch).toBe("master");
+    expect(auto.baseBranch).toBe("main");
   });
 
   test("should set custom baseBranch", async () => {
@@ -162,9 +170,11 @@ describe("Auto", () => {
     process.pkg = undefined;
   });
 
-  test("should throw if now GH_TOKEN set", async () => {
+  test("should throw if no GH_TOKEN set", async () => {
     const auto = new Auto();
     auto.logger = dummyLog();
+    // @ts-ignore
+    auto.getRepo = () => ({});
     process.env.GH_TOKEN = undefined;
     await expect(auto.loadConfig()).rejects.toBeInstanceOf(Error);
     process.env.GH_TOKEN = "XXXX";
@@ -187,7 +197,7 @@ describe("Auto", () => {
   test("should exit with errors in config", async () => {
     search.mockReturnValueOnce({ config: { name: 123 } });
     process.exit = jest.fn() as any;
-    const auto = new Auto();
+    const auto = new Auto({ owner: "foo", repo: "bar" });
     auto.logger = dummyLog();
     await auto.loadConfig();
     expect(process.exit).toHaveBeenCalled();
@@ -1426,12 +1436,16 @@ describe("Auto", () => {
     });
 
     test("should not publish when behind remote", async () => {
-      jest.spyOn(child, "execSync").mockImplementation((command) => {
-        if (command.startsWith("git")) {
-          throw new Error();
+      exec.mockImplementation((command, args) => {
+        if (
+          command.startsWith("git") &&
+          args[0] === "ls-remote" &&
+          args[1] === "--heads"
+        ) {
+          return Promise.reject(new Error());
         }
 
-        return Buffer.from("");
+        return Promise.resolve("");
       });
 
       const auto = new Auto({ ...defaults, plugins: [] });

packages/core/src/__tests__/changelog.test.ts

@@ -15,7 +15,7 @@ const testOptions = (): IGenerateReleaseNotesOptions => ({
   repo: "auto",
   baseUrl: "https://github.custom.com/foobar/auto",
   labels: [...defaultLabels],
-  baseBranch: "master",
+  baseBranch: "main",
   prereleaseBranches: ["next"],
 });
 
@@ -28,7 +28,7 @@ describe("createUserLink", () => {
       repo: "",
       baseUrl: "https://github.custom.com/",
       labels: [...defaultLabels],
-      baseBranch: "master",
+      baseBranch: "main",
       prereleaseBranches: ["next"],
     });
     changelog.loadDefaultHooks();
@@ -68,7 +68,7 @@ describe("createUserLink", () => {
       repo: "",
       baseUrl: "https://github.custom.com/",
       labels: [...defaultLabels],
-      baseBranch: "master",
+      baseBranch: "main",
       prereleaseBranches: ["next"],
     });
     changelog.loadDefaultHooks();
@@ -345,7 +345,7 @@ describe("generateReleaseNotes", () => {
         files: [],
         authorName: "Adam Dierkens",
         authorEmail: "[email protected]",
-        subject: "I was a push to master\n\nfoo bar",
+        subject: "I was a push to main\n\nfoo bar",
         labels: ["pushToBaseBranch"],
       },
       {
@@ -376,7 +376,7 @@ describe("generateReleaseNotes", () => {
         files: [],
         authorName: "Adam Dierkens",
         authorEmail: "[email protected]",
-        subject: "I was a push to master\n\nfoo bar",
+        subject: "I was a push to main\n\nfoo bar",
       },
       {
         hash: "2",
@@ -402,7 +402,7 @@ describe("generateReleaseNotes", () => {
         files: [],
         authorName: "Adam Dierkens",
         authorEmail: "[email protected]",
-        subject: "I was a push to master\n\n",
+        subject: "I was a push to main\n\n",
         labels: ["pushToBaseBranch"],
       },
       {
@@ -454,7 +454,7 @@ describe("generateReleaseNotes", () => {
         files: [],
         authorName: "Adam Dierkens",
         authorEmail: "[email protected]",
-        subject: "I was a push to master\n\n",
+        subject: "I was a push to main\n\n",
         labels: ["patch"],
       },
       {
@@ -543,7 +543,7 @@ describe("generateReleaseNotes", () => {
         files: [],
         authorName: "Adam Dierkens",
         authorEmail: "[email protected]",
-        subject: "I was a push to master\n\n",
+        subject: "I was a push to main\n\n",
         labels: ["pushToBaseBranch"],
       },
       {

packages/core/src/__tests__/get-remote.test.ts

@@ -1,4 +1,10 @@
 import { Auto } from "../auto";
+import { execSync } from "child_process";
+
+const exec = jest.fn();
+// @ts-ignore
+execSync.mockImplementation(exec);
+exec.mockReturnValue("");
 
 jest.mock("child_process");
 
@@ -69,4 +75,11 @@ describe("getRemote", () => {
       "https://x-access-token:[email protected]/fake/remote"
     );
   });
+
+  test("should use main if it exists", async () => {
+    exec.mockReturnValue("foo\nbar\nbaz\nmain");
+    const auto = new Auto();
+
+    expect(auto.baseBranch).toBe("main");
+  });
 });

packages/core/src/__tests__/git.test.ts

@@ -88,7 +88,7 @@ const options = {
   owner: "Adam Dierkens",
   repo: "test",
   token: "MyToken",
-  baseBranch: "master",
+  baseBranch: "main",
 };
 
 describe("github", () => {
@@ -129,7 +129,7 @@ describe("github", () => {
       const gh = new Git(options);
 
       gh.getTags = (ref: string) => {
-        if (ref === "origin/master") {
+        if (ref === "origin/main") {
           return Promise.resolve(["1.0.0", "1.2.3", "1.4.0"]);
         }
 
@@ -149,7 +149,7 @@ describe("github", () => {
       const gh = new Git(options);
 
       gh.getTags = (ref: string) => {
-        if (ref === "origin/master") {
+        if (ref === "origin/main") {
           return Promise.resolve(["1.0.0", "1.2.3", "1.4.0"]);
         }
 
@@ -179,7 +179,7 @@ describe("github", () => {
       const gh = new Git(options);
 
       gh.getTags = (ref: string) => {
-        if (ref === "origin/master") {
+        if (ref === "origin/main") {
           return Promise.resolve(baseTags);
         }
 
@@ -280,7 +280,7 @@ describe("github", () => {
   test("getTags", async () => {
     const gh = new Git(options);
 
-    expect(Array.isArray(await gh.getTags("master"))).toBe(true);
+    expect(Array.isArray(await gh.getTags("main"))).toBe(true);
   });
 
   test("getLastTagNotInBaseBranch", async () => {