nlm/lib/commands/release.js

Lifecycle manager for node projects

/*
 * Copyright (c) 2015, Groupon, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the name of GROUPON nor the names of its contributors may be
 * used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

'use strict';

const debug = require('debug')('nlm:command:release');

const semver = require('semver');

const generateChangeLog = require('../steps/changelog');

const createVersionCommit = require('../steps/version-commit');

const { generateBadges } = require('../steps/readme-badges');

const pushReleaseToRemote = require('../steps/push-to-remote');

const createGithubRelease = require('../steps/github-release');

const publishToNpm = require('../steps/publish-to-npm');

const executePrepareHookCommand = require('../steps/execute-prepare-hook-command');

const runVerify = require('./verify');

function bumpVersion(version, type) {
  if (type === 'none') {
    throw new Error('Cannot publish without changes');
  }

  if (/^0\./.test(version)) {
    return '1.0.0';
  }

  return semver.inc(version, type);
}

function release(cwd, pkg, options) {
  function setNextVersion() {
    /* eslint no-console: 0 */
    options.nextVersion = bumpVersion(pkg.version, options.releaseType);
    console.log(
      '[nlm] Publishing %j from %j as %j',
      options.nextVersion,
      options.currentBranch,
      options.distTag
    );
  }

  let publishTasks = [
    setNextVersion,
    executePrepareHookCommand,
    generateChangeLog,
    generateBadges,
    createVersionCommit,
    pushReleaseToRemote,
    createGithubRelease,
    publishToNpm,
  ];

  function runTask(task) {
    return task(cwd, pkg, options);
  }

  async function runPublishTasks() {
    if (options.pr) {
      debug('Never publishing from a PR');
      return null;
    }

    if (!options.commit) {
      debug('Skipping publish');
      return null;
    }

    if (!options.distTag) {
      debug('Skipping publish, no dist-tag');
      return null;
    }

    if (options.releaseType === 'none') {
      debug('No changes; just verifying NPM publish');
      publishTasks = [publishToNpm];
    }

    for (const task of publishTasks) await runTask(task);

    return null;
  }

  return runVerify(cwd, pkg, options).then(
    options.commit ? runPublishTasks : () => {}
  );
}

module.exports = release;