commuterjoy / haikro

A tool to make + deploy node apps as self contained tarballs to Heroku

haikro

A tool to make + deploy node apps as self contained tarballs to Heroku. Read the explainer on my blog.

Installation

npm install --save haikro

I currently recommend installing haikro as a normal dependency instead of a devDependency even though strictly speaking it shouldn't be used in production to stop it being deleted by npm prune --production.

Usage

Example Makefile:-

app := my-deplorable-app

deploy:
	# Clean+install dependencies
	git clean -fxd
	npm install

	# Build steps
	sass styles.scss public/styles.css
	
	# Remove devDependencies
	npm prune --production

	# Package+deploy
	@./node_modules/.bin/haikro build deploy \
		--app $(app) \
		--heroku-token $(HEROKU_AUTH_TOKEN) \
		--commit `git rev-parse HEAD`

Where HEROKU_AUTH_TOKEN is:

heroku auth:token

Example Procfile:-

web: server/app.js

Example .travis.yml

script:
- npm test
language: node_js
node_js:
- '0.10'
after_success:
- test $TRAVIS_PULL_REQUEST == "false" && test $TRAVIS_BRANCH == "master" && make deploy

Example of package.json

{
  "name": "My app",
  "version": "1.0.0",
  "engines": {
    "node": "0.10.x"
  }
}

Note: Haikro is also tested with codeship.io.

If you want to use iojs just change your package.json's engines to:-

{
  "name": "My app",
  "version": "1.0.0",
  "engines": {
    "iojs": "^1.0.3"
  }
}

CLI Options

• --app - Heroku app name
• --commit - free text used to identify a release
• --heroku-token - Heroku auth token
• --silent - displays no debug info
• --verbose - displays lot of debug info

Licence

This software is published by the Financial Times under the MIT licence.