forked from mbuchetics/heroku-buildpack-nodejs-grunt
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/master' into abtris/heroku_nod…
…epack_upgrade
- Loading branch information
Showing
93 changed files
with
3,299 additions
and
2,321 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
.anvil | ||
.DS_Store |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,65 +1,91 @@ | ||
Heroku buildpack: Node.js with grunt support | ||
============================================ | ||
Heroku Buildpack for Node.js | ||
============================ | ||
|
||
This is a fork of [Heroku's official Node.js buildpack](https://github.com/heroku/heroku-buildpack-nodejs) with added [grunt](https://github.com/cowboy/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. | ||
This is the official [Heroku buildpack](http://devcenter.heroku.com/articles/buildpacks) for Node.js apps. If you fork this repository, please **update this README** to explain what your fork does and why it's special. | ||
|
||
After all the default Node.js and NPM build tasks have finished, the buildpack checks if a gruntfile (`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](https://github.com/cowboy/grunt). 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. | ||
|
||
Usage | ||
----- | ||
How it Works | ||
------------ | ||
|
||
Create a new app with this buildpack: | ||
Here's an overview of what this buildpack does: | ||
|
||
heroku create myapp --buildpack https://github.com/mbuchetics/heroku-buildpack-nodejs-grunt.git | ||
- Uses the [semver.io](https://semver.io) webservice to find the latest version of node that satisfies the [engines.node semver range](https://npmjs.org/doc/json.html#engines) in your package.json. | ||
- Allows any recent version of node to be used, including [pre-release versions](https://semver.io/node.json). | ||
- Uses an [S3 caching proxy](https://github.com/heroku/s3pository#readme) 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](https://devcenter.heroku.com/articles/one-off-dynos#an-example-one-off-dyno). | ||
- 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](https://npmjs.org/doc/misc/npm-scripts.html) are executed. | ||
- Always runs `npm prune` after restoring cached modules to ensure cleanup of unused dependencies. | ||
|
||
Or add this buildpack to your current app: | ||
For more technical details, see the [heavily-commented compile script](https://github.com/heroku/heroku-buildpack-nodejs/blob/master/bin/compile). | ||
|
||
heroku config:add BUILDPACK_URL=https://github.com/mbuchetics/heroku-buildpack-nodejs-grunt.git | ||
|
||
Create your Node.js app and add a gruntfile named `grunt.js` with a `heroku` task: | ||
Documentation | ||
------------- | ||
|
||
grunt.registerTask('heroku', 'clean less mincss'); | ||
For more information about using Node.js and buildpacks on Heroku, see these Dev Center articles: | ||
|
||
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: | ||
- [Heroku Node.js Support](https://devcenter.heroku.com/articles/nodejs-support) | ||
- [Getting Started with Node.js on Heroku](https://devcenter.heroku.com/articles/nodejs) | ||
- [Buildpacks](https://devcenter.heroku.com/articles/buildpacks) | ||
- [Buildpack API](https://devcenter.heroku.com/articles/buildpack-api) | ||
|
||
"dependencies": { | ||
... | ||
"grunt": "*", | ||
"grunt-contrib": "*", | ||
"less": "*" | ||
} | ||
|
||
Push to heroku | ||
Legacy Compatibility | ||
-------------------- | ||
|
||
git push heroku master | ||
... | ||
-----> Heroku receiving push | ||
-----> Fetching custom buildpack... done | ||
-----> Node.js app detected | ||
-----> Resolving engine versions | ||
Using Node.js version: 0.8.2 | ||
Using npm version: 1.1.41 | ||
-----> Fetching Node.js binaries | ||
-----> Vendoring node into slug | ||
-----> Installing dependencies with npm | ||
... | ||
Dependencies installed | ||
-----> Building runtime environment | ||
-----> Found gruntfile, running grunt heroku task | ||
Running "heroku" task | ||
... | ||
-----> Discovering process types | ||
For most Node.js apps this buildpack should work just fine. If, however, you're unable to deploy using this new version of the buildpack, you can get your app working again by using the legacy branch: | ||
|
||
Further Information | ||
------------------- | ||
``` | ||
heroku config:set BUILDPACK_URL=https://github.com/heroku/heroku-buildpack-nodejs#legacy -a my-app | ||
git commit -am "empty" --allow-empty # force a git commit | ||
git push heroku master | ||
``` | ||
|
||
[Heroku: Buildpacks](https://devcenter.heroku.com/articles/buildpacks) | ||
Then please open a support ticket at [help.heroku.com](https://help.heroku.com/) so we can diagnose and get your app running on the default buildpack. | ||
|
||
[Heroku: Getting Started with Node.js](https://devcenter.heroku.com/articles/nodejs) | ||
Hacking | ||
------- | ||
|
||
[Buildpacks: Heroku for Everything](http://blog.heroku.com/archives/2012/7/17/buildpacks/) | ||
To make changes to this buildpack, fork it on Github. Push up changes to your fork, then create a new Heroku app to test it, or configure an existing app to use your buildpack: | ||
|
||
[Grunt: a task-based command line build tool for JavaScript projects](http://gruntjs.com/) | ||
``` | ||
# Create a new Heroku app that uses your buildpack | ||
heroku create --buildpack <your-github-url> | ||
# Configure an existing Heroku app to use your buildpack | ||
heroku config:set BUILDPACK_URL=<your-github-url> | ||
# You can also use a git branch! | ||
heroku config:set BUILDPACK_URL=<your-github-url>#your-branch | ||
``` | ||
|
||
For more detailed information about testing buildpacks, see [CONTRIBUTING.md](CONTRIBUTING.md) | ||
|
||
|
||
Testing | ||
------- | ||
|
||
[Anvil](https://github.com/ddollar/anvil) is a generic build server for Heroku. | ||
|
||
``` | ||
gem install anvil-cli | ||
``` | ||
|
||
The [heroku-anvil CLI plugin](https://github.com/ddollar/heroku-anvil) is a wrapper for anvil. | ||
|
||
``` | ||
heroku plugins:install https://github.com/ddollar/heroku-anvil | ||
``` | ||
|
||
The [ddollar/test](https://github.com/ddollar/buildpack-test) buildpack runs `bin/test` on your app/buildpack. | ||
|
||
``` | ||
heroku build -b ddollar/test # -b can also point to a local directory | ||
``` | ||
|
||
For more info on testing, see [Best Practices for Testing Buildpacks](https://discussion.heroku.com/t/best-practices-for-testing-buildpacks/294) on the Heroku discussion forum. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
error() { | ||
echo " ! $*" >&2 | ||
exit 1 | ||
} | ||
|
||
status() { | ||
echo "-----> $*" | ||
} | ||
|
||
protip() { | ||
echo | ||
echo "PRO TIP: $*" | indent | ||
echo "See https://devcenter.heroku.com/articles/nodejs-support" | indent | ||
echo | ||
} | ||
|
||
# sed -l basically makes sed replace and buffer through stdin to stdout | ||
# so you get updates while the command runs and dont wait for the end | ||
# e.g. npm install | indent | ||
indent() { | ||
c='s/^/ /' | ||
case $(uname) in | ||
Darwin) sed -l "$c";; # mac/bsd sed: -l buffers on line boundaries | ||
*) sed -u "$c";; # unix/gnu sed: -u unbuffered (arbitrary) chunks of data | ||
esac | ||
} | ||
|
||
cat_npm_debug_log() { | ||
test -f $build_dir/npm-debug.log && cat $build_dir/npm-debug.log | ||
} |
Oops, something went wrong.