Merge pull request #161 from loginx/release-automation

Release automation

.gitignore

@@ -4,3 +4,4 @@ extension/Handlebar.js
 upload.py
 gen/
 node_modules/
+.tmp/

Gruntfile.js

@@ -1,63 +1,205 @@
-'use strict';
-
 module.exports = function(grunt) {
+  'use strict';
+
+  require('load-grunt-tasks')(grunt);
+
   grunt.initConfig({
-    'git-describe': {
-      options: {
+    pkg: grunt.file.readJSON('package.json'),
+    changelog: 'Changelog.md',
+
+    'gh-release': {},
 
-      },
-      'run': {}
-    },
     closurecompiler: {
       minify: {
         requiresConfig: 'git-revision',
         files: {
-          "gen/axs_testing.js": [
-              "./lib/closure-library/closure/goog/base.js",
-              "./src/js/axs.js",
-              "./src/js/BrowserUtils.js",
-              "./src/js/Constants.js",
-              "./src/js/AccessibilityUtils.js",
-              "./src/js/Properties.js",
-              "./src/js/AuditRule.js",
-              "./src/js/AuditRules.js",
-              "./src/js/AuditResults.js",
-              "./src/js/Audit.js",
-              "./src/audits/*"
+          '.tmp/build/axs_testing.js': [
+              './lib/closure-library/closure/goog/base.js',
+              './src/js/axs.js',
+              './src/js/BrowserUtils.js',
+              './src/js/Constants.js',
+              './src/js/AccessibilityUtils.js',
+              './src/js/Properties.js',
+              './src/js/AuditRule.js',
+              './src/js/AuditRules.js',
+              './src/js/AuditResults.js',
+              './src/js/Audit.js',
+              './src/audits/*'
           ]
         },
         options: {
-          "language_in": "ECMASCRIPT5",
-          "formatting": "PRETTY_PRINT",
-          "summary_detail_level": 3,
-          "warning_level": "VERBOSE",
-          "compilation_level": "SIMPLE_OPTIMIZATIONS",
-          "output_wrapper": "<%= grunt.file.read('scripts/output_wrapper.txt') %>",
-          "externs": "./src/js/externs/externs.js"
+          'language_in': 'ECMASCRIPT5',
+          'formatting': 'PRETTY_PRINT',
+          'summary_detail_level': 3,
+          'warning_level': 'VERBOSE',
+          'compilation_level': 'SIMPLE_OPTIMIZATIONS',
+          'output_wrapper': "<%= grunt.file.read('scripts/output_wrapper.txt') %>",
+          'externs': './src/js/externs/externs.js'
         }
       }
     },
+
     qunit: {
       all: ['test/index.html']
+    },
+
+    copy: {
+      dist: {
+        expand: true,
+        cwd: '.tmp/build',
+        src: '**/*',
+        dest: 'dist/js'
+      }
+    },
+
+    clean: {
+      all: ['.tmp', 'dist']
+    },
+
+    bump: {
+      options: {
+        prereleaseName: 'rc',
+        files: ['package.json', 'bower.json'],
+        updateConfigs: ['pkg'],
+        pushTo: "<%= grunt.config.get('gh-release.remote') %>",
+        commitFiles: ['package.json', "<%= grunt.config.get('changelog') %>", 'bower.json', 'dist']
+      }
+    },
+
+    coffee: {
+      compile: {
+        files: {
+          '.tmp/util/gh_repo.js': 'src/util/gh_repo.coffee'
+        }
+      }
+    },
+
+    prompt: {
+      'gh-release': {
+        options: {
+          questions: [
+            {
+              config: 'gh-release.remote',
+              type: 'input',
+              message: 'Git Remote (usually upstream or origin)',
+              default: 'upstream',
+              validate: function(val) {
+                return (grunt.util._.size(val) > 0);
+              }
+            },
+            {
+              config: 'gh-release.repo',
+              type: 'input',
+              message: 'Github Repository',
+              default: 'GoogleChrome/accessibility-developer-tools',
+              validate: function(val) {
+                return (grunt.util._.size(val) > 0);
+              }
+            },
+            {
+              config: 'gh-release.username',
+              type: 'input',
+              message: 'Github Username',
+              validate: function(val) {
+                return (grunt.util._.size(val) > 0);
+              }
+            },
+            {
+              config: 'gh-release.password',
+              type: 'password',
+              message: 'Github Password or Token',
+              validate: function(val) {
+                return (grunt.util._.size(val) > 0);
+              }
+            }
+          ]
+        }
+      }
     }
   });
 
-  grunt.loadNpmTasks('grunt-closurecompiler');
-  grunt.loadNpmTasks('grunt-contrib-qunit');
+  grunt.registerTask('changelog', function(type) {
+    grunt.task.requires('bump-only:' + type);
 
-  grunt.registerTask('git-describe', function() {
-    var _spawn = require("grunt-util-spawn")(grunt);
+    var config = {
+      data: {
+        version: grunt.config.get('pkg.version'),
+        releaseDate: grunt.template.today("yyyy-mm-dd")
+      }
+    };
+
+    var stopRegex = /^\#\#\ [0-9]+.*$/m;
+    var stopIndex = 0;
+    var releaseNotes = '';
+    var dest = grunt.config.get('changelog');
+    var contents = grunt.file.read(dest);
+    var headerTpl = "## <%= version %> - <%= releaseDate %>\n\n";
+    var header = grunt.template.process(headerTpl, config);
+
+    if (contents.length > 0) {
+      if ((stopIndex = contents.search(stopRegex)) !== -1) {
+        releaseNotes = contents.slice(0, stopIndex);
+      }
+    }
+
+    grunt.config.set("gh-release.release-notes", releaseNotes);
+
+    grunt.file.write(dest, "" + header + contents);
+    grunt.log.ok("Changelog updated, and release notes extracted.");
+  });
+
+  grunt.registerTask('gh-release', function() {
+    // Compile and load GH Repo manager.
+    grunt.task.requires('coffee:compile');
+    var GHRepo = require('./.tmp/util/gh_repo');
+
+    var done = this.async();
+    var config = grunt.config.get('gh-release');
+    var pkg = grunt.config.get('pkg');
+    var currentRelease = 'v' + pkg.version;
+    var nextRelease = currentRelease.replace(/-rc\.[0-9]+/, '');
+    var repo = new GHRepo(config);
+    repo.log = function() { grunt.log.writeln.apply(grunt, arguments); };
 
+    var payload = {
+      tag_name: currentRelease,
+      name: nextRelease,
+      body: config['release-notes'],
+      draft: true
+    };
+
+    grunt.log.writeln("Searching for existing GH release:", nextRelease);
+    repo.getReleaseByName(nextRelease)
+      .then(function(release) {
+        if (release) {
+          payload.body += "\n" + release.body;
+          repo.updateRelease(release, payload).then(function() {
+            grunt.log.ok('Github release ' + nextRelease + ' updated successfully.');
+            done();
+          });
+        } else {
+          repo.createRelease(payload).then(function() {
+            grunt.log.ok('Github release ' + nextRelease + ' created successfully');
+            done();
+          });
+        }
+      })
+      .catch(function(err) {
+        throw err;
+      });
+  });
+
+  grunt.registerTask('git-describe', function() {
     // Start async task
     var done = this.async();
 
-    _spawn({
-      "cmd" : "git",
-      "args" : [ "rev-parse", "HEAD" ],
-      "opts" : {
-        "cwd" : "."
+    grunt.util.spawn({
+      'cmd' : 'git',
+      'args' : [ 'rev-parse', 'HEAD' ],
+      'opts' : {
+        'cwd' : '.'
       }
-      }, function(err, result) {
+    }, function(err, result) {
       if (err) {
           grunt.log.error(err).verbose.error(result);
           done();
@@ -69,20 +211,35 @@ module.exports = function(grunt) {
     });
   });
 
+  grunt.registerTask('release', function(releaseType) {
+    if (typeof releaseType === 'undefined' || releaseType === null) {
+      grunt.fail.fatal('You must specify a release type. i.e. grunt release:prerelease');
+    }
+
+    grunt.task.run([
+      'prompt:gh-release',
+      'build',
+      'test:unit',
+      'copy:dist',
+      'bump-only:' + releaseType,
+      'changelog:' + releaseType,
+      'bump-commit',
+      'coffee:compile',
+      'gh-release'
+    ]);
+  });
+
   grunt.registerTask('save-revision', function() {
     grunt.event.once('git-describe', function (rev) {
-      grunt.log.writeln("Git Revision: " + rev);
+      grunt.log.writeln('Git Revision: ' + rev);
       grunt.config.set('git-revision', rev);
     });
     grunt.task.run('git-describe');
   });
 
-  grunt.registerTask('copy-dist', function() {
-    grunt.file.copy('gen/axs_testing.js', 'dist/js/axs_testing.js');
-  });
-
-  grunt.registerTask('default', ['save-revision', 'closurecompiler:minify', 'qunit']);
-  grunt.registerTask('build', ['default', 'copy-dist']);
-  grunt.registerTask('travis', ['closurecompiler:minify', 'qunit']);
+  grunt.registerTask('build', ['clean:all', 'save-revision', 'closurecompiler:minify']);
+  grunt.registerTask('test:unit', ['qunit']);
+  grunt.registerTask('dist', ['build', 'copy:dist']);
+  grunt.registerTask('travis', ['closurecompiler:minify', 'test:unit']);
+  grunt.registerTask('default', ['build', 'test:unit']);
 };
-

package.json

@@ -6,11 +6,18 @@
     "url": "https://github.com/GoogleChrome/accessibility-developer-tools"
   },
   "devDependencies": {
+    "bluebird": "^2.9.27",
     "grunt": "^0.4.5",
+    "grunt-bump": "^0.3.1",
     "grunt-cli": "^0.1.13",
     "grunt-closurecompiler": "^0.9.9",
+    "grunt-contrib-clean": "^0.6.0",
+    "grunt-contrib-coffee": "^0.13.0",
+    "grunt-contrib-copy": "^0.8.0",
     "grunt-contrib-qunit": "^0.7.0",
-    "grunt-util-spawn": "^0.0.2"
+    "grunt-prompt": "^1.3.0",
+    "load-grunt-tasks": "^3.2.0",
+    "superagent": "^1.2.0"
   },
   "scripts": {
     "test": "grunt travis --verbose"

src/util/gh_repo.coffee

@@ -0,0 +1,69 @@
+request = require 'superagent'
+Promise = require 'bluebird'
+
+# Small utility class to interact with the Github v3 releases API.
+module.exports = class GHRepo
+  constructor: (@config = {}) ->
+    @baseUrl = "https://api.github.com/repos/#{@config.repo}"
+
+  _buildRequest: (req) ->
+    req
+      .auth @config.username, @config.password
+      .set 'Accept', 'application/vnd.github.v3'
+      .set 'User-Agent', 'grunt'
+
+  log: -> console.log.apply console, arguments
+
+  getReleaseByTagName: (tag) ->
+    # GET /repos/:owner/:repo/releases/tags/:tag
+    new Promise (resolve, reject) =>
+      @log 'GET', "#{@baseUrl}/releases/tags/#{tag}"
+      @_buildRequest(request.get "#{@baseUrl}/releases/tags/#{tag}")
+        .end (err, res) ->
+          return resolve() if res.statusCode is 404
+          return reject(err) if err?
+          return reject("Request failed") if res.statusCode isnt 200
+          resolve res.body
+
+  getReleases: (tag) ->
+    # GET /repos/:owner/:repo/releases
+    new Promise (resolve, reject) =>
+      @log 'GET', "#{@baseUrl}/releases"
+      @_buildRequest(request.get "#{@baseUrl}/releases")
+        .end (err, res) ->
+          return resolve() if res.statusCode is 404
+          return reject(err) if err?
+          return reject("Request failed") if res.statusCode isnt 200
+          resolve res.body
+
+  updateRelease: (release, payload) ->
+    # PATCH /repos/:owner/:repo/releases/:id
+    new Promise (resolve, reject) =>
+      @log 'PATCH', "#{@baseUrl}/releases/#{release.id}"
+      @_buildRequest(request.patch "#{@baseUrl}/releases/#{release.id}")
+        .send payload
+        .end (err, res) ->
+          return reject(err) if err?
+          return reject("Request failed") if res.statusCode isnt 200
+          resolve res.body
+
+  createRelease: (payload) ->
+    # POST /repos/:owner/:repo/releases
+    new Promise (resolve, reject) =>
+      @log 'POST', "#{@baseUrl}/releases"
+      @_buildRequest(request.post "#{@baseUrl}/releases")
+        .send payload
+        .end (err, res) ->
+          return reject(err) if err?
+          return reject("Request failed") if res.statusCode isnt 201
+          resolve res.body
+
+  getReleaseByName: (name) ->
+    new Promise (resolve, reject) =>
+      @getReleases().then (releases = []) ->
+        for release in releases
+          return resolve(release) if release.name is name
+
+        return resolve()
+      .catch (err) ->
+        reject "Unable to fetch project releases."