Build: Add --dry-run and improve the development experience

Closes gh-98

Author: gibson042

README.md

@@ -14,10 +14,10 @@ node release.js --remote=jquery/<project-name>
 
 ### Testing the Release Script
 
-***This only applies to those with access to some private repos. You can also use any other repo with a release script.***
-
 You can do a test run of the release script by using a different remote repository. **It is recommended to perform tests from a fresh clone of the project being released.** The script is smart enough to detect if you're using an official repository and adjust which actions are taken so that undesired actions, such as publishing to npm, don't occur for test runs.
 
+You can also explicitly specify `--dry-run` to skip actions that affect external state.
+
 When working on features of this script, adapt the following to simplify testing a bit, replacing the paths for `project` and `cdn`:
 
 ```bash
@@ -40,14 +40,14 @@ cd $cdn
 git push -f
 cd -
 
-rm -rf __release/
-node release.js --remote=$project
+npm run clean
+env TEST_REMOTE=$cdn node --dry-run release.js --remote=$project
 ```
 
-You need local clones of [fake-project](https://github.com/jquery/fake-project) and [fake-cdn](https://github.com/jquery/fake-cdn) (private, see note above), then update both variables to point to those.
-
 Save as `test-release.sh` in the checkout of this repo, make  it executable with `chmod +x test-release.sh`, then run with `./test-release.sh`.
 
+***If you have access to the private repositories [fake-project](https://github.com/jquery/fake-project) and [fake-cdn](https://github.com/jquery/fake-cdn)***, you can use them by dropping the `--dry-run` argument and updating the `TEST_REMOTE` environment variable to "git@github.com:jquery/fake-cdn.git".
+
 ### Full Usage Options
 
 See the [usage documentation](/docs/usage.txt) for the full set of options. You can also run the script with no parameters to see the usage.

docs/usage.txt

@@ -1,6 +1,9 @@
-Usage: node release.js [--pre-release=version] [--branch=branch] --remote=repo
+Usage: node release.js [--dry-run] [--pre-release=version] [--branch=branch] --remote=repo
 
 OPTIONS
+	--dry-run
+		Executes in test mode, skipping npm publish and CDN push.
+
 	--pre-release=version
 		Creates a pre-release instead of a stable release. Since the
 		version number can't be determined automatically, it must be

lib/bootstrap.js

@@ -41,6 +41,9 @@ Release.define({
 		Release._parseRemote();
 		Release.branch = Release.args.branch || "master";
 		Release.preRelease = Release.args.preRelease || false;
+		if ( Release.args.dryRun || Release.args.isTest ) {
+			Release.isTest = true;
+		}
 
 		if ( Release.preRelease && !semver.valid( Release.preRelease) ) {
 			Release.abort( "Invalid --pre-release argument, not valid semver: " +
@@ -54,7 +57,7 @@ Release.define({
 		console.log();
 
 		if ( Release.isTest ) {
-			console.log( "This is a test release. npm will not be updated." );
+			console.log( "This is a test release. GitHub and npm will not be updated." );
 		} else {
 			console.log( "This is a real release. GitHub and npm will be updated." );
 		}

lib/cdn.js

@@ -4,7 +4,7 @@ var shell = require( "shelljs" ),
 
 module.exports = function( Release ) {
 	var realRemote = "git@github.com:jquery/codeorigin.jquery.com.git",
-		testRemote = "git@github.com:jquery/fake-cdn.git";
+		testRemote = process.env.TEST_REMOTE || "git@github.com:jquery/fake-cdn.git";
 
 	function projectCdn() {
 		var project = Release.readPackage().name,
@@ -66,7 +66,8 @@ module.exports = function( Release ) {
 
 		_pushToCdn: function() {
 			Release.chdir( projectCdn() );
-			Release.exec( "git push", "Error pushing to CDN." );
+			Release.exec( "git push" + (Release.isTest ? " --dry-run" : ""),
+				"Error pushing to CDN." );
 			console.log();
 		}
 	});

lib/git.js

@@ -2,12 +2,12 @@ module.exports = function( Release ) {
 
 Release.define({
 	gitLog: function( format ) {
-		var command = "git log " + Release.prevVersion + ".." + Release.newVersion + " " +
-				"--format=\"" + format + "\"",
+		var commitRange = Release.prevVersion + ".." + Release.newVersion,
+			gitLog = "git log --format=\"" + format + "\" " + commitRange,
 			result = Release.exec({
-				command: command,
+				command: gitLog,
 				silent: true
-			}, "Error getting git log, command was: " + command );
+			}, "Error getting git log, command was: " + gitLog );
 
 		result = result.split( /\r?\n/ );
 		if ( result[ result.length - 1 ] === "" ) {

lib/github.js

@@ -27,7 +27,7 @@ Release.define({
 			})[ 0 ];
 
 			if ( !milestone ) {
-				Release.abort( "No milestone found." );
+				Release.abort( "Milestone not found: " + version );
 			}
 
 			callback( milestone.number );

lib/npm.js

@@ -1,5 +1,4 @@
-var chalk = require( "chalk" ),
-	shell = require( "shelljs" );
+var chalk = require( "chalk" );
 
 module.exports = function( Release ) {
 	Release.define({
@@ -17,7 +16,7 @@ module.exports = function( Release ) {
 		},
 
 		_getNpmOwners: function( npmPackage ) {
-			var result = shell.exec( "npm owner ls " + npmPackage, { silent: true } );
+			var result = Release.rawExec( "npm owner ls " + npmPackage, { silent: true } );
 			if ( result.code !== 0 ) {
 
 				// The npm package may not exist yet
@@ -68,26 +67,26 @@ module.exports = function( Release ) {
 
 			Release.chdir( Release.dir.repo );
 
-			var name = Release.readPackage().name,
-				npmTags = Release.npmTags(),
-				npmCommand = "npm publish --tag " + npmTags.pop();
+			var npmPublish,
+				newVersion = Release.readPackage().name + "@" + Release.newVersion,
+				safety = Release.isTest ? " --dry-run" : "",
+				npmTags = Release.npmTags();
 
 			if ( Release.isTest ) {
 				console.log( "Actual release would now publish to npm using:" );
 			} else {
 				console.log( "Publishing to npm, running:" );
 			}
 
-			console.log( "  " + chalk.cyan( npmCommand ) );
-			if ( !Release.isTest ) {
-				Release.exec( npmCommand );
-			}
+			npmPublish = "npm publish" + safety + " --tag " + npmTags.pop();
+			console.log( "  " + chalk.cyan( npmPublish ) );
+			Release.exec( npmPublish );
 
 			while ( npmTags.length ) {
-				npmCommand = "npm dist-tag add " + name + "@" + Release.newVersion + " " + npmTags.pop();
-				console.log( "  " + chalk.cyan( npmCommand ) );
+				npmPublish = "npm dist-tag add " + newVersion + " " + npmTags.pop();
+				console.log( "  " + chalk.cyan( npmPublish ) );
 				if ( !Release.isTest ) {
-					Release.exec( npmCommand );
+					Release.exec( npmPublish );
 				}
 			}
 

lib/repo.js

@@ -255,7 +255,8 @@ Release.define({
 	_pushRelease: function() {
 		Release.chdir( Release.dir.repo );
 		console.log( "Pushing release to git repo..." );
-		Release.exec( "git push --tags", "Error pushing tags to git repo." );
+		Release.exec( "git push" + (Release.isTest ? " --dry-run " : "") + " --tags",
+			"Error pushing tags to git repo." );
 	},
 
 	_updateBranchVersion: function() {
@@ -276,7 +277,8 @@ Release.define({
 	_pushBranch: function() {
 		Release.chdir( Release.dir.repo );
 		console.log( "Pushing " + chalk.cyan( Release.branch ) + " to GitHub..." );
-		Release.exec( "git push", "Error pushing to GitHub." );
+		Release.exec( "git push" + (Release.isTest ? " --dry-run " : ""),
+			"Error pushing to GitHub." );
 	}
 });
 

lib/util.js

@@ -4,6 +4,10 @@ var shell = require( "shelljs" ),
 module.exports = function( Release ) {
 
 Release.define({
+	rawExec: function( command, options ) {
+		return shell.exec( command, options );
+	},
+
 	exec: function( _options, errorMessage ) {
 		var result,
 			command = _options.command || _options,
@@ -15,7 +19,7 @@ Release.define({
 
 		errorMessage = errorMessage || "Error executing command: " + command;
 
-		result = shell.exec( command, options );
+		result = Release.rawExec( command, options );
 		if ( result.code !== 0 ) {
 			Release.abort( errorMessage );
 		}

package.json

@@ -12,7 +12,8 @@
     "grunt-contrib-jshint": "~0.7.2"
   },
   "scripts": {
-    "test": "grunt"
+    "test": "grunt",
+    "clean": "rm -rf __release/"
   },
   "repository": "jquery/jquery-release",
   "license": "MIT"