Grunt file snippet for buildcontrol: automated deployment using Git

Gruntfile-buildcontrol-snippet.js

/**
 * The following buildcontrol config will commit the built
 * files into a Git repo on our staging/production server.
 * 
 * The repos have a post-update hook that updates the code 
 * in the document root.
 */

module.exports = function (grunt) {

  // ...

  grunt.initConfig({

    // ...
    
    /**
     * Buildcontrol settings
     * 
     * @see https://blog.5apps.com/2014/05/29/deploying-static-apps-with-grunt-build-control-on-5apps-deploy.html
     * @see http://git-scm.com/book/en/Git-on-the-Server-Setting-Up-the-Server
     */
    buildcontrol: {
      options: {
        dir: 'dist',
        commit: true,
        push: true,
        message: 'Built %sourceName% from commit %sourceCommit% on branch %sourceBranch%'
      },
      development: {
        options: {
          remote: 'git@example.com:/git/example-development.git',
          branch: 'master'
        }
      },
      production: {
        options: {
          remote: 'git@example.com:/git/example-production.git',
          branch: 'master',
          tag: pkg.version
        }
      },
      local: {
        options: {
          remote: '../',
          branch: 'build'
        }
      }
    }
    
    // ...

  });

  // ...
  
  /**
   * Register 'grunt deploy' to build and then deploy
   */
  grunt.registerTask('deploy', function (environment) {
    grunt.task.run([
      'build',
      'buildcontrol:' + environment
    ]);
  });
  
  // ...

};