node-publisher 3.7.0 → 3.8.0

package/README.md

@@ -72,7 +72,7 @@ npx node-publisher eject
 After ejecting, a `.release.yml` file will appear in the root directory of your package. You can override the default behaviour by modifying this file.
 
 ## Custom branch
-Using the `--branch` release param, it is possible to specify which branch should be checked out during the `prepare` [lifecycle](#lifecycle) step. When no `branch` is specified, the `master` branch will be checked out by default.
+Using the `--branch` release param, it is possible to specify which branch should be checked out during the `prepare` [lifecycle](#lifecycle) step. When no `branch` is specified, the default branch of the repository is detected automatically: first via `origin/HEAD`, then by checking whether a `main` or `master` branch exists locally. If nothing can be detected, `main` is used as a fallback.
 
 ## Multiple configuration files
 
@@ -95,7 +95,7 @@ Example:
 
 The default release process assumes the following:
 
-- The master branch is called `master`.
+- The default branch is `main` or `master` (any other branch can be specified with the `--branch` release param).
 - A `.nvmrc` file is present in the root of your package. In case it is missing, the release fails in its preparation phase.
 - The tool expects the Node version to match the one in `.nvmrc` during the release process. If the expectation is not met, the release fails in its preparation phase.
 - The tool expects the build generation script to be called `build`. Otherwise, the build step is skipped.
@@ -105,7 +105,7 @@ The default release process assumes the following:
 
 # Lifecycle
 
-1. `prepare`: The process that prepares the workspace for releasing a new version of your package. It might checkout to master, check whether the working tree is clean, check the current node version, etc. Between this step and `test`, a rollback point is created for your git repo.
+1. `prepare`: The process that prepares the workspace for releasing a new version of your package. It might checkout to the default branch, check whether the working tree is clean, check the current node version, etc. Between this step and `test`, a rollback point is created for your git repo.
 
 2. `test`: Runs the tests and/or linting. You might want to configure the tool to run the same command as your CI tool does.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-publisher",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "description": "A configurable release automation tool inspired by create-react-app and Travis CI.",
   "author": "Attila Večerek <avecerek@zendesk.com>",
   "homepage": "https://github.com/zendesk/node-publisher#readme",
@@ -25,6 +25,7 @@
   "resolutions": {
     "tmp": "^0.2.6",
     "form-data": "^3.0.5",
+    "js-yaml": "^3.15.2",
     "lodash": "^4.18.1",
     "flatted": "^3.4.2",
     "filelist/minimatch": "^5.1.9",

package/src/client/yarn-berry.js

@@ -1,4 +1,5 @@
 const { packageJson } = require('../utils/package');
+const { getDefaultBranch } = require('../utils');
 
 const version = str => {
   if (str[0] === 'v') {
@@ -16,7 +17,9 @@ const publish = ({ nextVersion, execCommand, env }) => {
   execCommand(`git add package.json yarn.lock`);
   execCommand(`git commit -m "${version(pkg.version)}"`);
   execCommand(`git tag "${version(pkg.version)}"`);
-  execCommand(`git push origin ${env.branch || 'master'} --follow-tags`);
+  execCommand(
+    `git push origin ${env.branch || getDefaultBranch()} --follow-tags`
+  );
   execCommand(`yarn npm publish`);
 };
 

package/src/client/yarn-berry.spec.js

@@ -59,7 +59,7 @@ describe('publish', () => {
     const options = {
       nextVersion: 'major',
       preid: 'alpha',
-      env: { main: 'master' },
+      env: { branch: 'master' },
       execCommand: jest.fn()
     };
 

package/src/setup/release-branch/index.js

@@ -2,9 +2,9 @@ const fs = require('fs');
 const path = require('path');
 const childProcess = require('child_process');
 const { ask, addScript } = require('../utils');
-const { DEFAULT_BRANCH } = require('../../utils/constants');
 
 const GIT_PATH = path.resolve(process.env.PWD, '.git');
+const DEFAULT_BRANCHES = ['main', 'master'];
 
 const isGitRepo = () => fs.existsSync(GIT_PATH);
 
@@ -23,9 +23,17 @@ const gitBranches = () => {
 };
 
 const prioritizeDefaultBranch = branches => {
-  const index = branches.indexOf(DEFAULT_BRANCH);
+  const defaultBranch = DEFAULT_BRANCHES.find(branch =>
+    branches.includes(branch)
+  );
 
-  return index === -1 ? branches : branches.splice(index, 1).concat(branches);
+  if (!defaultBranch) {
+    return branches;
+  }
+
+  return [defaultBranch].concat(
+    branches.filter(branch => branch !== defaultBranch)
+  );
 };
 
 const question = () => ({
@@ -44,10 +52,7 @@ async function releaseBranchStep() {
   }
 
   const releaseBranch = await ask(question());
-  const releaseCommand =
-    releaseBranch === 'master'
-      ? 'node-publisher release'
-      : `node-publisher release --branch=${releaseBranch}`;
+  const releaseCommand = `node-publisher release --branch=${releaseBranch}`;
 
   addScript('release', releaseCommand);
 }

package/src/utils/constants.js

@@ -3,7 +3,7 @@ const os = require('os');
 
 const DEFAULT_TEST_RUNNER = 'travis';
 const VALID_TEST_RUNNERS = [DEFAULT_TEST_RUNNER, 'ci'];
-const DEFAULT_BRANCH = 'master';
+const DEFAULT_BRANCH = 'main';
 const DEFAULT_CONFIG_PATH = '.release.yml';
 const PACKAGE_JSON_PATH = path.resolve(process.env.PWD, 'package.json');
 const LERNA_JSON_PATH = path.resolve(process.env.PWD, 'lerna.json');

package/src/utils/index.js

@@ -1,25 +1,25 @@
-const path = require("path");
-const fs = require("fs");
-const command = require("./command");
+const path = require('path');
+const fs = require('fs');
+const command = require('./command');
 const {
   DEFAULT_CONFIG_PATH,
   DEFAULT_BRANCH,
   VALID_TEST_RUNNERS,
   DEFAULT_TEST_RUNNER
-} = require("./constants");
-const { npmClient, publishClient } = require("./client");
-const { readReleaseConfig, buildReleaseConfig } = require("./config");
-const { packageJson } = require("./package");
+} = require('./constants');
+const { npmClient, publishClient } = require('./client');
+const { readReleaseConfig, buildReleaseConfig } = require('./config');
+const { packageJson } = require('./package');
 const {
   validateNodeVersion,
   validatePkgRoot,
   validateTestRunner,
   validateLerna,
   hasBuildScript
-} = require("./validations");
+} = require('./validations');
 
 const buildReleaseEnvironment = ({
-  branch = DEFAULT_BRANCH,
+  branch,
   configPath = DEFAULT_CONFIG_PATH,
   quiet = false
 }) => {
@@ -40,14 +40,14 @@ const buildReleaseEnvironment = ({
   }
 
   const client = publishClient();
-  if (client === "lerna") {
+  if (client === 'lerna') {
     validateLerna();
   }
 
   return {
     publishClient: publishClient(),
     npmClient: npmClient(),
-    branch: branch,
+    branch: branch || getDefaultBranch(),
     configPath: configPath,
     testRunner: testRunner,
     withBuildStep: hasBuildScript()
@@ -60,7 +60,7 @@ const loadReleaseConfig = env => {
     : path.resolve(process.env.PWD, env.configPath);
 
   if (fs.existsSync(configPath)) {
-    return readReleaseConfig(fs.readFileSync(configPath, "utf8"));
+    return readReleaseConfig(fs.readFileSync(configPath, 'utf8'));
   } else if (env.configPath !== DEFAULT_CONFIG_PATH) {
     throw new Error(
       `The configuration file \`${env.configPath}\` does not exist.`
@@ -82,20 +82,57 @@ const execCommands = configCommands => {
 
 const currentCommitId = () =>
   command
-    .exec("git rev-parse HEAD", {})
+    .exec('git rev-parse HEAD', {})
     .toString()
     .trim();
 
+const getDefaultBranch = () => {
+  try {
+    return command
+      .exec('git symbolic-ref --short refs/remotes/origin/HEAD', {
+        stdio: ['ignore', 'pipe', 'ignore']
+      })
+      .toString()
+      .replace(/^origin\//, '')
+      .trim();
+  } catch (e) {
+    // origin/HEAD is not always set (e.g. repos cloned before the remote
+    // existed or with an old git version), so fall through to local branches.
+  }
+
+  try {
+    const branches = command
+      .exec('git branch', { stdio: ['ignore', 'pipe', 'ignore'] })
+      .toString()
+      .split('\n')
+      .map(line => line.replace(/^\*?\s*/, '').trim())
+      .filter(Boolean);
+
+    const detected = ['main', 'master'].find(branch =>
+      branches.includes(branch)
+    );
+
+    if (detected) {
+      return detected;
+    }
+  } catch (e) {
+    // No local branches to inspect either; fall through to the default.
+  }
+
+  return DEFAULT_BRANCH;
+};
+
 const rollbackCommit = commitId => command.exec(`git reset --hard ${commitId}`);
 
 const versionTransformer = (version, _answers, flags) =>
-  flags.isFinal && version[0] !== "v" ? `v${version}` : version;
+  flags.isFinal && version[0] !== 'v' ? `v${version}` : version;
 
 module.exports = {
   buildReleaseEnvironment,
   loadReleaseConfig,
   execCommands,
   currentCommitId,
+  getDefaultBranch,
   rollbackCommit,
   versionTransformer
 };

package/src/utils/index.spec.js

@@ -40,6 +40,8 @@ describe('buildReleaseEnvironment', () => {
     throw new Error();
   };
 
+  afterEach(() => execSync.mockClear());
+
   describe('when branch is passed', () => {
     beforeAll(() => mockTestRunner('test'));
 
@@ -51,11 +53,94 @@ describe('buildReleaseEnvironment', () => {
   });
 
   describe('when branch is not passed', () => {
+    afterEach(() => execSync.mockClear());
+
     it('contains the default branch', () => {
       const env = buildReleaseEnvironment({});
 
       expect(env.branch).toBe(DEFAULT_BRANCH);
     });
+
+    describe('and the origin HEAD points to main', () => {
+      beforeAll(() => {
+        childProcess.__permitCommands(['git']);
+        childProcess.__setReturnValues({
+          'git symbolic-ref --short refs/remotes/origin/HEAD': Buffer.from(
+            'origin/main\n',
+            'utf8'
+          )
+        });
+      });
+
+      afterAll(() => {
+        childProcess.__permitCommands(['mycommand', 'mySecondCommand']);
+        childProcess.__setReturnValues({
+          'git symbolic-ref --short refs/remotes/origin/HEAD': undefined
+        });
+      });
+
+      it('contains the detected default branch', () => {
+        const env = buildReleaseEnvironment({});
+
+        expect(env.branch).toBe('main');
+      });
+    });
+
+    describe('and the origin HEAD is not set but master exists locally', () => {
+      beforeAll(() => {
+        childProcess.__permitCommands(['git']);
+        childProcess.__setReturnValues({
+          'git symbolic-ref --short refs/remotes/origin/HEAD': undefined,
+          'git branch': Buffer.from('  feature-x\n* master\n', 'utf8')
+        });
+      });
+
+      afterAll(() => {
+        childProcess.__permitCommands(['mycommand', 'mySecondCommand']);
+        childProcess.__setReturnValues({
+          'git symbolic-ref --short refs/remotes/origin/HEAD': undefined,
+          'git branch': undefined
+        });
+      });
+
+      it('falls back to the local master branch', () => {
+        const env = buildReleaseEnvironment({});
+
+        expect(env.branch).toBe('master');
+      });
+    });
+
+    describe('and the origin HEAD is not set but main exists locally', () => {
+      beforeAll(() => {
+        childProcess.__permitCommands(['git']);
+        childProcess.__setReturnValues({
+          'git symbolic-ref --short refs/remotes/origin/HEAD': undefined,
+          'git branch': Buffer.from('  main\n* feature-x\n', 'utf8')
+        });
+      });
+
+      afterAll(() => {
+        childProcess.__permitCommands(['mycommand', 'mySecondCommand']);
+        childProcess.__setReturnValues({
+          'git symbolic-ref --short refs/remotes/origin/HEAD': undefined,
+          'git branch': undefined
+        });
+      });
+
+      it('falls back to the local main branch', () => {
+        const env = buildReleaseEnvironment({});
+
+        expect(env.branch).toBe('main');
+      });
+    });
+
+    describe('and the origin HEAD cannot be detected', () => {
+      it('falls back to the default branch', () => {
+        const env = buildReleaseEnvironment({});
+
+        expect(env.branch).toBe(DEFAULT_BRANCH);
+      });
+    });
   });
 
   describe('when configPath is passed', () => {