gabrielteodosio / buildpacks-nodejs

Heroku's official Cloud Native Buildpacks for the Node.js ecosystem.

Heroku Cloud Native Node.js Buildpacks

Heroku's official Cloud Native Buildpacks for the Node.js ecosystem.

Included Buildpacks

ID	Name	Readme	Changelog	Latest Version
heroku/nodejs	Node.js	Readme	Changelog
heroku/nodejs-engine	Node.js Engine	Readme	Changelog
heroku/nodejs-npm	NPM	Readme	Changelog
heroku/nodejs-yarn	Yarn	Readme	Changelog

The heroku/nodejs meta-buildpack is the recommended buildpack for most applications. It includes heroku/nodejs-engine, heroku/nodejs-npm, and heroku/nodejs-yarn.

Classic Heroku Buildpack

If you're looking for the repositories of the classic Node.js Heroku buildpack for usage on the Heroku platform, please see heroku/nodejs.

Development

Dependencies

For all buildpacks:

• Bash >= 5.0

For libcnb.rs buildpacks:

• All libcnb.rs dependencies

For bash buildpacks:

• yj >= 5.0.0
• jq >= 1.6
• shpec

For cutlass integration tests

• Ruby >= 2.7
• bundler via gem install bundler

Building

1. Build a buildpack or meta-buildpack by running it's build.sh script (if it has one): ./meta-buildpacks/nodejs/build.sh
2. Use the buildpack to build an app: pack build example-app --buildpack meta-buildpacks/nodejs/target --path /path/to/example-app

Build script conventions

Many of the buildpacks in this repository require a separate build step before they can be used. By convention, build scripts must be located in a file named build.sh in the buildpack root directory.

build.sh scripts:

• MUST NOT depend on a specific working directory and can be called from anywhere
• MUST write the finished buildpack to target/ within the buildpack directory

Testing

• cargo test performs Rust unit and intgration tests for the heroku/nodejs-engine buildpack.
• bundle exec rspec test/specs/node runs cutlass integration tests for the heroku/nodejs buildpack.
• bundle exec rspec test/specs/node-function runs cutlass integration tests for the heroku/nodejs-function buildpack.
• shpec buildpacks/npm/shpec/*_shpec.sh runs the shpec unit tests for the heroku/nodejs-npm buildpack.
• shpec buildpacks/nodejs-function-invoker/shpec/*_shpec.sh runs the shpec unit tests for the heroku/nodejs-function-invoker buildpack.

Releasing

Deploy Cloud Native Buildpacks

License

Licensed under the MIT License. See LICENSE file.