package.toml

A buildpackage configuration schema is as follows:

  • buildpack (required)

    The buildpack to package. It must contain the following field:

    • uri (string, required)
      A URL or path to an archive, or a path to a directory. If path is relative, it must be relative to the package.toml.
  • dependencies (list, optional)

    A set of dependent buildpack locations, for packaging a meta-buildpack. Each dependent buildpack location must correspond to an order group within the meta-buildpack being packaged, and must have one of the following fields:

    • uri (string)
      A URL or path to an archive, a packaged buildpack (saved as a .cnb file), or a directory. If path is relative, it must be relative to the package.toml.
  • platform (optional)

    The expected runtime environment for the buildpackage. It should contain the following field:

    • os (string, optional)
      The operating system type that the buildpackage will run on. Only linux or windows is supported. If omitted, linux will be the default.

Further Reading

You can view sample buildpackages on Github.