From 2e83483e089e2505952f76a8ba90900c3c88444a Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Sat, 15 Jun 2019 13:42:52 -0700 Subject: [PATCH 1/4] Support dry run publishing using --dry --- bin/publish.js | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/bin/publish.js b/bin/publish.js index 9df2e982..d9e2798e 100644 --- a/bin/publish.js +++ b/bin/publish.js @@ -11,6 +11,11 @@ const packageJson = require('../package.json'); // Setup auth fs.writeFileSync(`${process.env['HOME']}/.npmrc`, `//registry.npmjs.org/:_authToken=${process.env['NPM_AUTH_TOKEN']}`); +const isDryRun = process.argv.indexOf('--dry') !== -1; +if (isDryRun) { + console.log('Publish dry run'); +} + // Determine if this is a stable or beta release const publishedVersions = getPublishedVersions(); const isStableRelease = publishedVersions.indexOf(packageJson.version) === -1; @@ -22,15 +27,23 @@ 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)); +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'); } -const result = cp.spawn('npm', args, { stdio: 'inherit' }); -result.on('exit', code => process.exit(code)); +if (isDryRun) { + console.log(`Spawn: npm ${args.join(' ')}`); +} else { + const result = cp.spawn('npm', args, { stdio: 'inherit' }); + result.on('exit', code => process.exit(code)); +} function getNextBetaVersion() { if (!/^[0-9]+\.[0-9]+\.[0-9]+$/.exec(packageJson.version)) { @@ -61,3 +74,6 @@ function getPublishedVersions(version, tag) { } return versionsJson; } + +function publishPackage(packageDir) { +} From 15c99869f5f6929b7af36b53261e567df1a19f0a Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Sat, 15 Jun 2019 13:51:13 -0700 Subject: [PATCH 2/4] Start of publishing addons Part of #2165 --- addons/xterm-addon-attach/package.json | 2 +- addons/xterm-addon-fit/package.json | 2 +- addons/xterm-addon-search/package.json | 2 +- addons/xterm-addon-web-links/package.json | 2 +- bin/publish.js | 77 +++++++++++++---------- 5 files changed, 49 insertions(+), 36 deletions(-) diff --git a/addons/xterm-addon-attach/package.json b/addons/xterm-addon-attach/package.json index 1d72b144..84740e1e 100644 --- a/addons/xterm-addon-attach/package.json +++ b/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/" diff --git a/addons/xterm-addon-fit/package.json b/addons/xterm-addon-fit/package.json index 4ee8e1b7..6e553700 100644 --- a/addons/xterm-addon-fit/package.json +++ b/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/" diff --git a/addons/xterm-addon-search/package.json b/addons/xterm-addon-search/package.json index 02cb6695..5a607fe9 100644 --- a/addons/xterm-addon-search/package.json +++ b/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/" diff --git a/addons/xterm-addon-web-links/package.json b/addons/xterm-addon-web-links/package.json index a764a200..fd3945d3 100644 --- a/addons/xterm-addon-web-links/package.json +++ b/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/" diff --git a/bin/publish.js b/bin/publish.js index d9e2798e..fd2475c4 100644 --- a/bin/publish.js +++ b/bin/publish.js @@ -6,7 +6,6 @@ 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']}`); @@ -16,36 +15,53 @@ if (isDryRun) { console.log('Publish dry run'); } -// Determine if this is a stable or beta release -const publishedVersions = getPublishedVersions(); -const isStableRelease = publishedVersions.indexOf(packageJson.version) === -1; +const publishablePackages = [ + path.resolve(__dirname, '..'), + 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') +]; -// Get the next version -let nextVersion = isStableRelease ? packageJson.version : getNextBetaVersion(); -console.log(`Publishing version: ${nextVersion}`); +publishablePackages.forEach(p => checkAndPublishPackage(p)); -// Set the version in package.json -const packageJsonFile = path.resolve(__dirname, '..', 'package.json'); -packageJson.version = nextVersion; -if (isDryRun) { - console.log(`Set version of ${packageJsonFile} to ${nextVersion}`); -} else { - fs.writeFileSync(packageJsonFile, JSON.stringify(packageJson, null, 2)); +function checkAndPublishPackage(packageDir) { + const packageJson = require(path.join(packageDir, 'package.json')); + console.group('Checking package ' + packageJson.name); + + // 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(); } -// 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)); -} - -function getNextBetaVersion() { +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); @@ -53,7 +69,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`; } @@ -66,7 +82,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) { @@ -74,6 +90,3 @@ function getPublishedVersions(version, tag) { } return versionsJson; } - -function publishPackage(packageDir) { -} From 64403f2dca174b7686b0b06457f95d3ad0af6ea4 Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Sat, 15 Jun 2019 14:06:45 -0700 Subject: [PATCH 3/4] Publish addons and xterm based on whether files changed Fixes #2165 --- bin/publish.js | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/bin/publish.js b/bin/publish.js index fd2475c4..3bacb585 100644 --- a/bin/publish.js +++ b/bin/publish.js @@ -15,19 +15,30 @@ if (isDryRun) { console.log('Publish dry run'); } -const publishablePackages = [ - path.resolve(__dirname, '..'), +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') ]; -publishablePackages.forEach(p => checkAndPublishPackage(p)); +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 +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')); - console.group('Checking package ' + packageJson.name); // Determine if this is a stable or beta release const publishedVersions = getPublishedVersions(packageJson); @@ -90,3 +101,11 @@ function getPublishedVersions(packageJson, 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; +} From d06fd04465bf31db14cc9436ee62b389124e8cef Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Sat, 15 Jun 2019 14:10:48 -0700 Subject: [PATCH 4/4] Move addon const under addon comment --- bin/publish.js | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/bin/publish.js b/bin/publish.js index 3bacb585..fb6b3ee2 100644 --- a/bin/publish.js +++ b/bin/publish.js @@ -15,13 +15,6 @@ if (isDryRun) { console.log('Publish dry run'); } -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') -]; - const changedFiles = getChangedFilesInCommit('HEAD'); // Publish xterm if any files were changed outside of the addons directory @@ -30,6 +23,12 @@ if (changedFiles.some(e => e.search(/^addons\//) === -1)) { } // 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)) {