This repo has moved to https://github.com/heroku/buildpacks-node.

This buildpack builds on top of the existing Node.js Engine Cloud Native Buildpack and one of the package manager buildpacks. It runs subsequent scripts after Node is install.

• Run automatically
  • tsc

Using brew (assuming development is done on MacOS), install pack.

brew tap buildpack/tap
brew install pack

If you're using Windows or Linux, follow instructions here.

This buildpack uses shpec for unit tests, so to run them locally, you'll need to install the package.

curl -sLo- http://get.bpkg.sh | bash
bpkg install rylnd/shpec

Right now, we are prototyping with a local version of the buildpack. Clone it to your machine.

git clone [email protected]:heroku/nodejs-typescript-buildpack.git

Clone the Heroku Node.js Engine Cloud Native Buildpack and Node.js NPM Cloud Native Buildpack.

cd .. # change from nodejs-typescript-buildpack directory
git clone [email protected]:heroku/nodejs-npm-buildpack.git
git clone [email protected]:heroku/nodejs-engine-buildpack.git

Note: Node.js Yarn CNB can also be used instead of the NPM buildpack.

Using pack, you're ready to create an image from the buildpack and source code. You will need to add flags that point to the path of the source code (--path) and the paths of the buildpacks (--buildpack).

cd nodejs-typescript-buildpack
pack build TEST_IMAGE_NAME --path ../TEST_REPO_PATH --buildpack ../nodejs-engine-buildpack --buildpack ../nodejs-npm-buildpack --buildpack nodejs-typescript-buildpack

You can also create a builder.toml file that will have explicit directions when creating a buildpack. This is useful when there are multiple "detect" paths a build can take (ie. yarn vs. npm commands).

In a directory outside of this buildpack, create a builder file:

cd ..
mkdir heroku_nodejs_builder
touch heroku_nodejs_builder/builder.toml

For local development, you'll want the file to look like this:

[[buildpacks]]
  id = "heroku/nodejs-engine"
  uri = "../nodejs-engine-buildpack"

[[buildpacks]]
  id = "heroku/nodejs-npm"
  uri = "../nodejs-npm-buildpack"

[[buildpacks]]
  id = "heroku/nodejs-typescript"
  uri = "../nodejs-typescript-buildpack"

[[order]]
  group = [
    { id = "heroku/nodejs-engine-buildpack", version = "0.4.3" },
    { id = "heroku/nodejs-npm-buildpack", version = "0.1.4" },
    { id = "heroku/nodejs-typescript-buildpack", version = "0.0.1" }
  ]

[stack]
  id = "heroku-18"
  build-image = "heroku/pack:18"
  run-image = "heroku/pack:18"

Create the builder with pack:

pack create-builder node-typescript --builder-config ../heroku-nodejs-builder/builder.toml

Now you can use the builder image instead of chaining the buildpacks.

pack build TEST_IMAGE_NAME --path ../TEST_REPO_PATH --builder node-typescript

The complete test suite needs Docker to run. Make sure to install Docker first.

make test

If you want to run individual test suites, that's available too.

Unit Tests

To run the tests on the local host, make sure shpec is installed.

make unit-test

Running the shpec aren't ideal since the test scripts read and write to the local buildpack directory, so Docker may be preferred.

As suggested above, install Docker. Next, run the tests with the Make script:

make docker-unit-test

To debug, make changes from the code and rerun with the make command. To see what is happening, I suggest wrapping code blocks in question with set -x/set +x. It would look like this in the shpec file:

set -x
it "creates a toolbox.toml"
  install_or_reuse_toolbox "$layers_dir/toolbox"

  assert file_present "$layers_dir/toolbox.toml"
end
set +x

1. Open a pull request.
2. Make update to CHANGELOG.md under main with a description (PR title is fine) of the change, the PR number and link to PR.
3. Let the tests run on CI. When tests pass and PR is approved, the branch is ready to be merged.
4. Merge branch to main.

Note: if you're not a contributor to this project, a contributor will have to make the release for you.

1. Create a new branch (ie. 1.14.2-release).
2. Update the version in the buildpack.toml.
3. Move the changes from main to a new header with the version and date (ie. 1.14.2 (2020-02-30)).
4. Open a pull request.
5. Let the tests run on CI. When tests pass and PR is approved, the branch is ready to be merged.
6. Merge branch to main.
7. Pull down main to local machine.
8. Tag the current main with the version. (git tag v1.14.2)
9. Push up to GitHub. (git push origin main --tags) CI will run the suite and create a new release on successful run.

• buildpacks: provide framework and a runtime for source code. Read more here.
• OCI image: OCI (Open Container Initiative) is a project to create open sourced standards for OS-level virtualization, most importantly in Linux containers.