Initial commit.

Author: scottgonzalez

.gitignore

@@ -0,0 +1,2 @@
+node_modules/grunt
+node_modules/grunt-contrib-jshint

.jshintrc

@@ -0,0 +1,17 @@
+{
+	"boss": true,
+	"curly": true,
+	"eqeqeq": true,
+	"eqnull": true,
+	"expr": true,
+	"immed": true,
+	"noarg": true,
+	"onevar": true,
+	"quotmark": "double",
+	"smarttabs": true,
+	"trailing": true,
+	"undef": true,
+	"unused": true,
+
+	"node": true
+}

Gruntfile.js

@@ -0,0 +1,16 @@
+module.exports = function( grunt ) {
+
+grunt.loadNpmTasks( "grunt-contrib-jshint" );
+
+grunt.initConfig({
+	jshint: {
+		options: {
+			jshintrc: true
+		},
+		all: [ "release.js", "lib/*.js" ]
+	}
+});
+
+grunt.registerTask( "default", [ "jshint" ] );
+
+};

README.md

@@ -0,0 +1,196 @@
+# jQuery Project Release Automation
+
+This script automates releases for all jQuery projects. It is designed to create
+consistency between projects and reduce the burden of maintaining individual
+release scripts.
+
+## Creating a Release
+
+Creating a release is as simple as cloning this repository and telling the
+script which project to use. In order to ensure a clean and proper release is
+created, you should always start from a new clone of this repository.
+
+```sh
+git clone git@github.com:jquery/jquery-release.git
+cd jquery-release
+node jquery-release.js --remote=jquery/<project-name>
+```
+
+### Testing the Release Script
+
+You can do a test run of the release script by using a different remote
+repository. 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.
+
+### Full Usage Options
+
+See the [usage documenation](/docs/usage.txt) for the full set of options.
+You can also run the script with no parameters to see the usage.
+
+
+
+## Creating a Project-Specific Release Script
+
+This script only performs the set of common functionality across all projects.
+Each project may have additional functionality. Any project-specific
+configuration and functionality must be defined in the `build/release.js` file
+inside the project's repository.
+
+Here's a minimal example:
+
+```js
+module.exports = function( Release ) {
+
+Release.define({
+	issueTracker: "trac",
+	contributorReportId: 37,
+	changelogShell: function() {
+		return "# Amazing Changelog for v" + Release.newVersion + "\n";
+	}
+});
+
+};
+```
+
+### Required/Recommended Configuration
+
+#### checkRepoState()
+
+Performs any project-specific checks to ensure the repository is in a good state
+to be released. For example, there is a built-in check to ensure that
+AUTHORS.txt is up-to-date.
+
+This method has no return value. If a project-specific check fails, the script
+should use `Release.abort()` to prevent the release from continuing.
+
+#### generateArtifacts( callback )
+
+Generates any release artifacts that should be included in the release. The
+callback must be invoked with an array of files that should be committed before
+creating the tag.
+
+#### changelogShell()
+
+Defines the shell for the changelog. The changelog is created by concatenating
+the shell, the commit log, and the issue list.
+
+#### issueTracker
+
+Which type of issue tracker is being used for the project. Must be either
+`"trac"` or `"github"`.
+
+#### contributorReportId
+
+If using Trac, this defines which report will produce a list of contributors
+for a specific release.
+
+See [docs/track-contributors.sql](docs/track-contributors.sql) for the SQL
+necessary to create the Trac report.
+
+### Other Methods
+
+#### define( props )
+
+Defines new properties and methods to add to the `Release` object.
+
+#### abort( msg )
+
+Aborts the release and prints the message.
+
+#### exec( command, options )
+
+Executes the given `command`. You can pass `{ silent: true }` to suppress output
+on the command line.
+
+Returns the output.
+
+#### git( command, errorMessage )
+
+Executes the given git `command`. If the command fails, the release will be
+aborted and `errorMessage` will be displayed.
+
+#### gitLog( format )
+
+Gets a git log using the specified format. If the log fails, the release will be
+aborted.
+
+Returns an array of commits.
+
+#### prompt( callback )
+
+Prompts the user for input.
+
+Passes the input to `callback`.
+
+#### confirm( callback )
+
+Prompts the user to confirm they want to continue with the release script. If
+the user decides not to continue, the release will be aborted and `callback`
+won't be invoked.
+
+#### confirmReview( callback )
+
+Prompts the user to review the output and confirm they want to continue with the
+release script. If the user decides not to continue, the release will be aborted
+and `callback` won't be invoked.
+
+#### trac( path )
+
+Gets the results of a Trac query, with tab-delimited results.
+
+Returns the tab-delimited string.
+
+#### readPackage()
+
+Gets the contents of `package.json` as an object.
+
+#### writePackage( package )
+
+Saves `package` to `package.json`, preserving indentation style.
+
+### Other Properties
+
+#### isTest
+
+Whether this is a test release.
+
+#### project
+
+The name of the project being released.
+
+#### remote
+
+The location of the remote repository.
+
+#### preRelease
+
+The version number for a pre-release version, or `false` for stable releases.
+
+#### dir.base
+
+The main directory used for the release script.
+
+#### dir.repo
+
+The directory for the local repository.
+
+#### newVersion
+
+The version being released.
+
+#### prevVersion
+
+The previous release version (used for determining what changed).
+
+#### nextVersion
+
+The version that will be set in `package.json` after the release.
+
+#### tagTime
+
+Timestamp for the release tag.
+
+#### branch
+
+Which branch the release is being generated from.

docs/trac-contributors.sql

@@ -0,0 +1,13 @@
+(SELECT DISTINCT `reporter` AS `contributor`
+	FROM `ticket`
+	WHERE `resolution` = "fixed"
+		AND `milestone` = $V)
+UNION
+(SELECT DISTINCT `author`
+	FROM `ticket_change`
+	WHERE `ticket` IN (
+		SELECT `id`
+			FROM `ticket`
+			WHERE `resolution` = "fixed"
+			AND `milestone` = $V))
+ORDER BY CAST(`contributor` AS CHAR)

docs/usage.txt

@@ -0,0 +1,27 @@
+Usage: node release.js [--pre-release=version] [--branch=branch] --remote=repo
+
+OPTIONS
+	--pre-release=version
+		Creates a pre-release instead of a stable release. Since the
+		version number can't be determined automatically, it must be
+		provided, and must be a valid semver.
+
+	--branch=branch
+		Specifies which branch to create the release from.
+		Defaults to master.
+
+	--remote=repo
+		Specifies the remote repository to work with. There are three
+		ways to specify the remote:
+
+		- GitHub Repository (user/repo)
+		- File System (/path/to/repo)
+		- URL (http://mydomain/repo.git)
+
+		Regardless of which method is used to specify the remote, the
+		part after the last slash must match the repo name on GitHub.
+
+TEST RELEASES
+	To test the release process without affecting any official
+	repositories, specificy a custom remote, such as your own fork of
+	the repository.

lib/bootstrap.js

@@ -0,0 +1,91 @@
+var fs = require( "fs" ),
+	path = require( "path" );
+
+module.exports = function( Release ) {
+
+Release.define({
+	isTest: true,
+
+	_showUsage: function() {
+		console.log( fs.readFileSync( path.resolve( __dirname, "../docs/usage.txt" ), "utf8" ) );
+	},
+
+	_parseArguments: function() {
+		Release.args = {};
+
+		process.argv.forEach(function( arg ) {
+			var name, value,
+				matches = /--([^=]+)(=(.+))?/.exec( arg );
+
+			if ( matches ) {
+				name = matches[ 1 ].replace( /-([a-z])/gi, function( all, letter ) {
+					return letter.toUpperCase();
+				});
+				value = matches[ 3 ] || true;
+				Release.args[ name ] = value;
+			}
+		});
+
+		Release._parseRemote();
+		Release.branch = Release.args.branch || "master";
+		Release.preRelease = Release.args.preRelease || false;
+
+		console.log();
+		console.log( "\tProject: " + Release.project );
+		console.log( "\tRelease type: " + (Release.preRelease ? "pre-release" : "stable") );
+		console.log( "\tRemote: " + Release.remote );
+		console.log( "\tBranch: " + Release.branch );
+		console.log();
+
+		if ( Release.isTest ) {
+			console.log( "This is a test release. npm will not be updated." );
+		} else {
+			console.log( "This is a real release. GitHub and npm will be updated." );
+		}
+	},
+
+	_parseRemote: function() {
+		var remote = Release.args.remote;
+
+		if ( !remote ) {
+			console.log( "Missing required remote repo." );
+			console.log();
+			Release._showUsage();
+			process.exit( 1 );
+		}
+
+		// URL
+		if ( /:\/\//.test( remote ) ) {
+			Release.project = remote.replace( /.+\/([^\/]+)\.git/, "$1" );
+
+		// filesystem or GitHub
+		} else {
+			Release.project = remote.split( "/" ).pop();
+
+			// If it's not a local path, it must be a GitHub repo
+			if ( !fs.existsSync( remote ) ) {
+				Release.isTest = !/^jquery\//.test( remote );
+				remote = "git@github.com:" + remote + ".git";
+			}
+		}
+
+		Release.remote = remote;
+	},
+
+	_createReleaseDirectory: function() {
+		console.log( "Determining directories..." );
+		Release.dir = { base: process.cwd() + "/__release" };
+		Release.dir.repo = Release.dir.base + "/repo";
+
+		if ( fs.existsSync( Release.dir.base ) ) {
+			console.log( "The directory '" + Release.dir.base + "' already exists." );
+			console.log( "Aborting." );
+			process.exit( 1 );
+		}
+
+		console.log( "Creating directory..." );
+		fs.mkdirSync( Release.dir.base );
+	}
+});
+
+};