Merge pull request #2232 from Tyriar/publish_improvements

Add publish dry run feature and automate addon released based on changed files

addons/xterm-addon-attach/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xterm-addon-attach",
-  "version": "0.1.0-beta11",
+  "version": "0.1.0",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"

addons/xterm-addon-fit/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xterm-addon-fit",
-  "version": "0.1.0-beta3",
+  "version": "0.1.0",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"

addons/xterm-addon-search/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xterm-addon-search",
-  "version": "0.1.0-beta6",
+  "version": "0.1.0",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"

addons/xterm-addon-web-links/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xterm-addon-web-links",
-  "version": "0.1.0-beta10",
+  "version": "0.1.0",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"

bin/publish.js

@@ -6,33 +6,72 @@
 const cp = require('child_process');
 const fs = require('fs');
 const path = require('path');
-const packageJson = require('../package.json');
 
 // Setup auth
 fs.writeFileSync(`${process.env['HOME']}/.npmrc`, `//registry.npmjs.org/:_authToken=${process.env['NPM_AUTH_TOKEN']}`);
 
-// Determine if this is a stable or beta release
-const publishedVersions = getPublishedVersions();
-const isStableRelease = publishedVersions.indexOf(packageJson.version) === -1;
-
-// Get the next version
-let nextVersion = isStableRelease ? packageJson.version : getNextBetaVersion();
-console.log(`Publishing version: ${nextVersion}`);
-
-// Set the version in package.json
-const packageJsonFile = path.resolve(__dirname, '..', 'package.json');
-packageJson.version = nextVersion;
-fs.writeFileSync(packageJsonFile, JSON.stringify(packageJson, null, 2));
-
-// Publish
-const args = ['publish'];
-if (!isStableRelease) {
-  args.push('--tag', 'beta');
+const isDryRun = process.argv.indexOf('--dry') !== -1;
+if (isDryRun) {
+  console.log('Publish dry run');
 }
-const result = cp.spawn('npm', args, { stdio: 'inherit' });
-result.on('exit', code => process.exit(code));
 
-function getNextBetaVersion() {
+const changedFiles = getChangedFilesInCommit('HEAD');
+
+// Publish xterm if any files were changed outside of the addons directory
+if (changedFiles.some(e => e.search(/^addons\//) === -1)) {
+  checkAndPublishPackage(path.resolve(__dirname, '..'));
+}
+
+// Publish addons if any files were changed inside of the addon
+const addonPackageDirs = [
+  path.resolve(__dirname, '../addons/xterm-addon-attach'),
+  path.resolve(__dirname, '../addons/xterm-addon-fit'),
+  path.resolve(__dirname, '../addons/xterm-addon-search'),
+  path.resolve(__dirname, '../addons/xterm-addon-web-links')
+];
+addonPackageDirs.forEach(p => {
+  const addon = path.basename(p);
+  if (changedFiles.some(e => e.indexOf(addon) !== -1)) {
+    checkAndPublishPackage(p);
+  }
+});
+
+function checkAndPublishPackage(packageDir) {
+  const packageJson = require(path.join(packageDir, 'package.json'));
+
+  // Determine if this is a stable or beta release
+  const publishedVersions = getPublishedVersions(packageJson);
+  const isStableRelease = publishedVersions.indexOf(packageJson.version) === -1;
+
+  // Get the next version
+  let nextVersion = isStableRelease ? packageJson.version : getNextBetaVersion(packageJson);
+  console.log(`Publishing version: ${nextVersion}`);
+
+  // Set the version in package.json
+  const packageJsonFile = path.join(packageDir, 'package.json');
+  packageJson.version = nextVersion;
+  if (isDryRun) {
+    console.log(`Set version of ${packageJsonFile} to ${nextVersion}`);
+  } else {
+    fs.writeFileSync(packageJsonFile, JSON.stringify(packageJson, null, 2));
+  }
+
+  // Publish
+  const args = ['publish'];
+  if (!isStableRelease) {
+    args.push('--tag', 'beta');
+  }
+  if (isDryRun) {
+    console.log(`Spawn: npm ${args.join(' ')}`);
+  } else {
+    const result = cp.spawn('npm', args, { stdio: 'inherit' });
+    result.on('exit', code => process.exit(code));
+  }
+
+  console.groupEnd();
+}
+
+function getNextBetaVersion(packageJson) {
   if (!/^[0-9]+\.[0-9]+\.[0-9]+$/.exec(packageJson.version)) {
     console.error('The package.json version must be of the form x.y.z');
     process.exit(1);
@@ -40,7 +79,7 @@ function getNextBetaVersion() {
   const tag = 'beta';
   const stableVersion = packageJson.version.split('.');
   const nextStableVersion = `${stableVersion[0]}.${parseInt(stableVersion[1]) + 1}.0`;
-  const publishedVersions = getPublishedVersions(nextStableVersion, tag);
+  const publishedVersions = getPublishedVersions(packageJson, nextStableVersion, tag);
   if (publishedVersions.length === 0) {
     return `${nextStableVersion}-${tag}1`;
   }
@@ -53,7 +92,7 @@ function getNextBetaVersion() {
   return `${nextStableVersion}-${tag}${latestTagVersion + 1}`;
 }
 
-function getPublishedVersions(version, tag) {
+function getPublishedVersions(packageJson, version, tag) {
   const versionsProcess = cp.spawnSync('npm', ['view', packageJson.name, 'versions', '--json']);
   const versionsJson = JSON.parse(versionsProcess.stdout);
   if (tag) {
@@ -61,3 +100,11 @@ function getPublishedVersions(version, tag) {
   }
   return versionsJson;
 }
+
+function getChangedFilesInCommit(commit) {
+  const args = ['log', '-m', '-1', '--name-only', `--pretty=format:`, commit];
+  const result = cp.spawnSync('git', args);
+  const output = result.stdout.toString();
+  const changedFiles = output.split('\n').filter(e => e.length > 0);
+  return changedFiles;
+}