heroku-buildpack-nodejs-grunt-compass

by davious

GitHub Readme.md

Heroku buildpack: Node.js with grunt support

Supported Grunt versions: 0.3 and 0.4. See the Grunt migration guide if you are upgrading from 0.3.

This is a fork of Heroku's official Node.js buildpack with added Grunt support. Using this buildpack you do not need to commit the results of your Grunt tasks (e.g. minification and concatination of files), keeping your repository clean.

After all the default Node.js and npm build tasks have finished, the buildpack checks if a Gruntfile (Gruntfile.js, Gruntfile.coffeeor grunt.js) exists and executes the heroku task by running grunt heroku. For details about grunt and how to define tasks, check out the offical documentation. You must add grunt to the npm dependencies in your package.json file. If no Gruntfile exists, the buildpacks simply skips the grunt step and executes like the standard Node.js buildpack.

How it Works

Here's an overview of what this buildpack does:

  • Uses the semver.io webservice to find the latest version of node that satisfies the engines.node semver range in your package.json.
  • Allows any recent version of node to be used, including pre-release versions.
  • Uses an S3 caching proxy of nodejs.org for faster downloads of the node binary.
  • Discourages use of dangerous semver ranges like * and >0.10.
  • Uses the version of npm that comes bundled with node.
  • Puts node and npm on the PATH so they can be executed with heroku run.
  • Caches the node_modules directory across builds for fast deploys.
  • Doesn't use the cache if node_modules is checked into version control.
  • Runs npm rebuild if node_modules is checked into version control.
  • Always runs npm install to ensure npm script hooks are executed.
  • Always runs npm prune after restoring cached modules to ensure cleanup of unused dependencies.
  • Installs a GIT_SSH_KEY to the ssh agent to allow for private bower repository access, if set.
  • Runs grunt if a Gruntfile (Gruntfile.js, Gruntfile.coffeeor grunt.js) is found.
  • Doesn't install grunt-cli every time.
  • Installs compass, caching it for future use.

For more technical details, see the heavily-commented compile script.

Usage

Create a new app with this buildpack:

heroku create myapp --buildpack heroku config:add BUILDPACK_URL=https://github.com/stephanmelzer/heroku-buildpack-nodejs-grunt-compass.git

Or add this buildpack to your current app:

heroku config:add BUILDPACK_URL=https://github.com/stephanmelzer/heroku-buildpack-nodejs-grunt-compass.git

Set the NODE_ENV environment variable (e.g. development or production):

heroku config:set NODE_ENV=production

Set the GIT_SSH_KEY environment variable, if using private github repositories

ssh-keygen -t rsa -b 4096 -C "mygithubemail@example.com" -N "" -f key
pbcopy < key.pub # add public key to github, use cat key.pub if command not found
heroku config:set GIT_SSH_KEY=`cat key | base64 -w 0` -a my-heroku-app

Create your Node.js app and add a Gruntfile named Gruntfile.js (or Gruntfile.coffee if you want to use CoffeeScript, or grunt.js if you are using Grunt 0.3) with a heroku task:

grunt.registerTask('heroku:development', 'clean less mincss');

or

grunt.registerTask('heroku:production', 'clean less mincss uglify');

Don't forget to add grunt to your dependencies in package.json. If your grunt tasks depend on other pre-defined tasks make sure to add these dependencies as well:

"dependencies": {
    ...
    "grunt": "*",
    "grunt-contrib": "*",
    "less": "*"
}

Push to heroku

git push heroku master
...
----> Fetching custom git buildpack... done
-----> Node.js app detected
-----> Requested node range:  0.10.x
-----> Resolved node version: 0.10.25
-----> Downloading and installing node
-----> Found Gruntfile
-----> Augmenting package.json with grunt and grunt-cli
-----> Restoring node_modules directory from cache
-----> Pruning cached dependencies not specified in package.json
       npm WARN package.json mealgen@0.0.0 No repository field.
-----> Detected SSH key for git.  launching ssh-agent and loading key
-----> Installing dependencies
       npm WARN package.json mealgen@0.0.0 No repository field.
-----> Caching node_modules directory for future builds
-----> Cleaning up node-gyp and npm artifacts
-----> Installing Compass
-----> Restoring ruby gems directory from cache
Updating installed gems
Nothing to update
-----> Caching ruby gems directory for future builds
-----> Building runtime environment
-----> Running grunt heroku: task

Debugging

npm can be run with a verbose flag to help debugging if something fails when installing the dependencies.

  • if the VERBOSE environment variable is set, npm is always run with verbose logging.
  • if BUILDPACK_RETRY_VERBOSE is set, npm is relaunched in verbose mode if npm failed.

Thanks to mackwic for these extensions.

Further Information

For more information about using Node.js and buildpacks on Heroku, see these Dev Center articles: