@process-engine/ci_tools/src/commands/commit-and-tag-version.ts

CI tools for process-engine.io

import * as yargsParser from 'yargs-parser';
import * as chalk from 'chalk';

import { getChangelogText } from './internal/create-changelog';
import { getGitBranch, gitAdd, gitCommit, gitPush, gitPushTags, gitTag } from '../git/git';
import { getPackageVersion, getPackageVersionTag } from '../versions/package_version';
import { getPrevVersionTag } from '../versions/git_helpers';
import { setupGit } from './internal/setup-git-and-npm-connections';
import { sh } from '../cli/shell';
import { isRedundantRunTriggeredBySystemUserPush, isRetryRunForPartiallySuccessfulBuild } from '../versions/retry_run';
import { printMultiLineString } from '../cli/printMultiLineString';
import { PACKAGE_MODE_DOTNET, PACKAGE_MODE_NODE, PACKAGE_MODE_PYTHON } from '../contracts/modes';

const COMMAND_NAME = 'commit-and-tag-version';
const BADGE = `[${COMMAND_NAME}]\t`;
const DEFAULT_MODE = 'node';

const DOC = `
Commits, tags and pushes the current version (when on one of the applicable branches).
`;
// DOC: see above

export async function run(...args): Promise<boolean> {
  const argv = yargsParser(args, { alias: { help: ['h'] }, default: { mode: DEFAULT_MODE } });
  const isDryRun = argv.dry === true;
  const isForced = process.env.CI_TOOLS_FORCE_PUBLISH === 'true' || argv.force === true;
  const mode = argv.mode;

  setupGit();

  await printInfo(mode, isDryRun, isForced);

  if (await isRedundantRunTriggeredBySystemUserPush(mode)) {
    const currentVersionTag = getPackageVersionTag(mode);
    console.error(chalk.yellow(`${BADGE}Current commit is tagged with "${currentVersionTag}".`));
    console.error(chalk.yellowBright(`${BADGE}Nothing to do here, since this is the current package version!`));

    process.exit(0);
  }

  if (await isRetryRunForPartiallySuccessfulBuild(mode)) {
    console.error(chalk.yellow(`${BADGE}This seems to be a retry run for a partially successful build.`));
    console.error(chalk.yellowBright(`${BADGE}Nothing to do here!`));

    process.exit(0);
  }

  annotatedSh('git config user.name');
  annotatedSh('git config user.email');

  const packageVersion = await getPackageVersion(mode);
  const preVersionTag = await getPrevVersionTag(mode);
  const changelogText = await getChangelogText(mode, preVersionTag);

  if (isDryRun) {
    console.log(`${BADGE}Would commit version ${packageVersion} and tag the commit as "v${packageVersion}".`);
    console.log(`${BADGE}Skipping since this is a dry run!`);
    return true;
  }

  const commitSuccessful = pushCommitAndTagCurrentVersion(mode, packageVersion, changelogText);

  if (commitSuccessful) {
    console.log(
      chalk.greenBright(`${BADGE}Committed version ${packageVersion} and tagged that commit as "v${packageVersion}"`)
    );
  }

  return true;
}

export function getShortDoc(): string {
  return DOC.trim().split('\n')[0];
}

export function printHelp(): void {
  console.log(`Usage: ci_tools ${COMMAND_NAME} <package-pattern> [<package-pattern>...] [--dry] [--force]`);
  console.log('');
  console.log(DOC.trim());
}

function annotatedSh(cmd: string): string {
  console.log(`${BADGE}|>>> ${cmd}`);
  const output = sh(cmd);
  printMultiLineString(output, `${BADGE}| `);

  return output;
}

async function printInfo(mode: string, isDryRun: boolean, isForced: boolean): Promise<void> {
  const packageVersion = await getPackageVersion(mode);
  const packageVersionTag = await getPackageVersionTag(mode);
  const branchName = getGitBranch();

  console.log(`${BADGE}isDryRun:`, isDryRun);
  console.log(`${BADGE}isForced:`, isForced);
  console.log('');
  console.log(`${BADGE}packageVersion:`, packageVersion);
  console.log(`${BADGE}packageVersionTag:`, packageVersionTag);
  console.log(`${BADGE}branchName:`, branchName);
  console.log('');
}

function pushCommitAndTagCurrentVersion(mode: string, currentVersion: string, changelogText: string): boolean {
  const branchName = getGitBranch();
  const currentVersionTag = `v${currentVersion}`;

  sh(`git checkout ${branchName}`);

  addPackageFilesToGit(mode);

  sh('git status');

  gitCommit(`Release ${currentVersionTag}\n\n${changelogText}\n\n[skip ci]`);
  gitTag(currentVersionTag);
  gitPush('origin', branchName);
  gitPushTags();

  // TODO: we should check if these were successful!
  return true;
}

function addPackageFilesToGit(mode: string): void {
  switch (mode) {
    case PACKAGE_MODE_DOTNET:
      gitAdd('*.csproj');
      break;
    case PACKAGE_MODE_NODE:
      gitAdd('package.json');
      gitAdd('package-lock.json');
      break;
    case PACKAGE_MODE_PYTHON:
      gitAdd('setup.py');
      break;
    default:
      throw new Error(`Unknown value for \`mode\`: ${mode}`);
  }
}