github-release-from-changelog/github-release-from-changelog.js

Create GitHub releases from CHANGELOG.md

#!/usr/bin/env node

var changelogFileNames = [
  "CHANGELOG.md",
  "Changelog.md",
  "changelog.md",
  "CHANGES.md",
  "Changes.md",
  "changes.md",
  "HISTORY.md",
  "History.md",
  "history.md",
  "NEWS.md",
  "News.md",
  "news.md",
  "RELEASES.md",
  "Releases.md",
  "releases.md"
];

/**
 * GitHub release from an package.json + CHANGELOG
 *
 * Usage:
 *   $ GITHUB_TOKEN=aGitHubToken
 *   $ github-release-from-changelog [--filename CustomChangelog.md]
 *
 * we will use `grizzly` (https://github.com/coderaiser/node-grizzly)
 * so we need
 * - user (user from package.json repo field)
 * - repo (same as)user
 * - tag (version)
 * - release name (tag)
 * - description (changelog section corresponding to tag)
 */

// read command line arguments
var cp = require("child_process");
var minimist = require("minimist");
var argv = minimist(process.argv.slice(2));

var fs = require("fs");

// changelog file name
var changelogFileName = argv.filename;
if (!changelogFileName) {
  for (var fileName of changelogFileNames) {
    if (fs.existsSync(fileName)) {
      changelogFileName = fileName;
      break;
    }
  }
}
// console.log("changelog filename", changelogFileName);

// get dep
var release = require("grizzly");

// read package.json
var pkg;
try {
  pkg = require(process.cwd() + "/package.json");
} catch (e) {
  throw "No package.json found in " + process.cwd();
}

// read changelog
var changelog;
try {
  changelog = fs.readFileSync(process.cwd() + "/" + changelogFileName, {
    encoding: "utf8"
  });
} catch (e) {
  throw "No " + changelogFileName + " found in " + process.cwd();
}

// parse repository url to get user & repo slug
var repoUrl;
repoUrl = pkg.repository;
if (repoUrl === undefined) {
  throw "No repository.url found in " + process.cwd() + "/repository(.url)";
}
if (typeof repoUrl === "object" && repoUrl.url) {
  repoUrl = repoUrl.url;
}
var matches = repoUrl.match(
  /(?:https?|git(?:\+ssh)?)(?::\/\/)(?:www\.)?github\.com\/(.*)/i
);
if (matches === null) {
  throw "Unable to parse repository url";
}
var repoData = matches[1].split("/");
var user = repoData[0];
var repo = repoData[1].replace(/\.git$/, "");

// version
var version = pkg.version;

// Look for the tag in either X.Y.Z or vX.Y.X formats
var tags = cp.execSync("git tag", { encoding: "utf8" });
var tagMatches = tags.match(new RegExp("^(v?)" + version + "$", "gm"));
var tagName;
if (tagMatches === null) {
  throw "Tag " + version + " or v" + version + " not found";
} else {
  tagName = tagMatches[0];
}

// changelog
var body = [];
var start = false;
var changelogLines = changelog.replace(/\r\n/g, "\n").split("\n");

// accept various ways to specify version starting like
// # 1.0
// ## v1.0
// ## [v1.0
var versionStartStringRe = "^##? \\[?v?";
var versionStartRe = new RegExp(versionStartStringRe);
var versionRe = new RegExp(versionStartStringRe + version.replace(/\./, "."));
var footerLinkRe = new RegExp("^\\[");

changelogLines.some(function(line, i) {
  argv.debug && console.log("MATCH", line.match(versionRe));
  if (!start && line.match(versionRe)) {
    start = true;
    argv.debug && console.log("START");
  } else if (
    start &&
    (line.match(versionStartRe) || line.match(footerLinkRe))
  ) {
    argv.debug && console.log("END");
    return true;
  } else if (start) {
    argv.debug && console.log(line);
    // between start & end, collect lines
    body.push(line);
  }
  argv.debug && console.log("IGNORED " + line);
});
body = body.join("\n").trim();

// prepare release data
var releaseOptions = {
  user: user,
  repo: repo,
  tag: tagName,
  name: tagName,
  body: body
};

var githubReleaseUrl =
  "https://github.com/" + user + "/" + repo + "/releases/tag/" + tagName;

if (argv.dryRun) {
  console.log(tagName);
  console.log();
  console.log("---");
  console.log(body);
  console.log("---");
  console.log();
  console.log("NOT released, link below should not have the release notes");
  console.log(githubReleaseUrl);
} else {
  var token = process.env.GITHUB_TOKEN;
  if (!token) {
    throw "GITHUB_TOKEN required";
  }

  release(token, releaseOptions, function(err) {
    if (err) {
      throw err;
    }
    console.log(githubReleaseUrl);
  });
}