v0.14.0

Added

• libcnb-package: Added cross-compilation assistance for Linux aarch64-unknown-linux-musl. (#577)
• libcnb-cargo: Added --package-dir command line option to control where packaged buildpacks are written. (#583)
• libcnb-test:
  • LogOutput now implements std::fmt::Display. (#635)
  • ContainerConfig now implements Clone. (#636)

Changed

• libcnb-cargo: Moved the default location for packaged buildpacks from Cargo's target/ directory to packaged/ in the Cargo workspace root. This simplifies the path and stops modification of the target/ directory which previously might have caching implications when other tools didn't expect non-Cargo output in that directory. Users that implicitly rely on the output directory need to adapt. The output of cargo libcnb package will refer to the new locations. (#583)
• libcnb-package:
  • buildpack target directory now contains the target triple. Users that implicitly rely on the output directory need to adapt. The output of cargo libcnb package will refer to the new locations. (#580)
  • get_buildpack_target_dir was renamed to get_buildpack_package_dir (#583)
• libcnb-test:
  • ContainerContext::address_for_port will now panic for all failure modes rather than just some, and so now returns SocketAddr directly instead of Option<SocketAddr>. This reduces test boilerplate due to the caller no longer needing to .unwrap() and improves debugging UX when containers crash after startup. (#605 and #636)
  • Docker commands are now run using the Docker CLI instead of Bollard and the Docker daemon API. (#620)
  • ContainerConfig::entrypoint now accepts a String rather than a vector of strings. Any arguments to the entrypoint should be moved to ContainerConfig::command. (#620)
  • Removed TestRunner::new since its only purpose was for advanced configuration that's no longer applicable. Use TestRunner::default instead. (#620)
  • Removed stdout_raw and stderr_raw from LogOutput. (#607)
  • Improved wording of panic error messages. (#619 and #620)
• libherokubuildpack: Changed the flate2 decompression backend from miniz_oxide to zlib. (#593)

Fixed

• libcnb-test:
  • TestContext::run_shell_command and ContainerContext::shell_exec now validate the exit code of the spawned commands and panic if they are non-zero. (#620)
  • ContainerContext::expose_port now only exposes the port to localhost. (#610)
  • If a test with an expected result of PackResult::Failure unexpectedly succeeds, the built app image is now correctly cleaned up. (#625)

v0.13.0

The highlight of this release is the cargo libcnb package changes to support compilation of both buildpacks and meta-buildpacks.

Changed

• libcnb-cargo: The cargo libcnb package command now supports compiling buildpacks and meta-buildpacks (#575):
  • When used in a buildpack directory it will compile only that buildpack.
  • When used in a workspace directory it will compile all buildpacks found in subdirectories.
• libcnb-package: Changed default_buildpack_directory_name to accept a BuildpackId (#575)

Added

• libcnb-cargo
  • Buildpacks can reference other buildpacks within a workspace by using uri = "libcnb:{buildpack_id}" as a dependency entry in the buildpack's package.toml file. (#575)
• libcnb-data
  • Serialization / deserialization of package.toml files supported with the Buildpackage struct. (#575)
• libcnb-package
  • Added read_buildpackage_data, find_buildpack_dirs, get_buildpack_target_dir to support packaging operations. (#575)
  • Added buildpack_dependency::BuildpackDependency, buildpack_dependency::get_local_buildpackage_dependencies, buildpack_dependency::rewrite_buildpackage_local_dependencies, buildpack_dependency::rewrite_buildpackage_relative_path_dependencies_to_absolute to support Buildpack dependency handling and packaging operations. (#575)
  • Added buildpack_package::BuildpackPackage, buildpack_package::read_buildpack_package to support libcnb.rs-based Rust packages. (#575)
  • Added dependency_graph::DependencyNode, dependency_graph::create_dependency_graph, dependency_graph::get_dependencies to support dependency ordering and resolution in libcnb.rs-based Rust packages. (#575)

v0.12.0

Highlight of this release is the bump to Buildpack API 0.9. This release contains breaking changes, please refer to the items below for migration advice.

Changed

• libcnb.rs now targets Buildpack API 0.9. Buildpacks need to upgrade the api key to 0.9 in their buildpack.toml. (#567)
  • Process no longer supports the direct flag. All processes are now direct. Processes that need to use bash can use bash explicitly in the command. (#567)
  • Process::command has been changed to a sequence of values where the first one is the executable and any additional values are arguments to the executable. The already existing args field behaves slightly different now as its contents can now be overridden by the user. See the upstream CNB specification for details. (#567)
• Env::get now returns Option<&OsString> instead of Option<OsString>. This is more in line with expectations users have when dealing with a collection type. This is a breaking change, compile errors can be fixed by adding a Option::cloned call after Env::get to get the old behaviour. In some cases, cloning might not be necessary, slightly improving the code that uses Env::get. (#565)

Added

• Env::get_string_lossy as a convenience method to work with environment variables directly. Getting a value out of an Env and treating its contents as unicode is a common case. Using this new method can simplify buildpack code. (#565)
• Clone implementation for libcnb::layer_env::Scope. (#566)

v0.11.5

Changed

• Update toml to 0.7.1. If your buildpack interacts with TOML data directly, you probably want to bump
  the toml version in your buildpack as well. (#556)

v0.11.4

Added

• libcnb-data: Store struct now supports clone() and default(). (#547)

v0.11.3

Added

• libcnb: Add store field to BuildContext, exposing the contents of store.toml if present. (#543)

v0.11.2

Fixed

• libcnb-test: TestContext::download_sbom_files now checks the exit code of the pack sbom download command it runs. (#520)

Changed

• libcnb: Drop the use of the stacker crate when recursively removing layer directories. (#517)
• libcnb-cargo: Updated to Clap v4. (#511)

Added

• libherokubuildpack: Add command and write modules for working with std::process::Command output streams. (#535)

v0.11.1

Fixed

• All crates now properly include the LICENSE file. (#506)
• Fix libcnb readme file metadata which prevented vendoring libcnb via cargo vendor. (#506)

Changed

• Improve the libherokubuildpack root module rustdocs. (#503)

v0.11.0

Changed

• Bump Minimum Supported Rust Version (MSRV) to 1.64. (#500)
• Bump minimum external dependency versions. (#502)

Added

• Add new crate libherokubuildpack with common code that can be useful when implementing buildpacks with libcnb. Originally hosted in a separate, private, repository. Code from libherokubuildpack might eventually find its way into libcnb.rs proper. At this point, consider it an incubator. (#495)

v0.10.0

Highlight of this release is the bump to Buildpack API 0.8 which brings support for SBOM to libcnb.rs. This is also the first release where all libcnb.rs crates are released at the same time and with the same version number. See the changelog below for other changes.

Changed

• libcnb.rs now targets Buildpack API 0.8. Buildpacks need to upgrade the api key to 0.8 in their buildpack.toml. (#489)
• In accordance to the CNB specification >=0.7, BuildpackId no longer permits sbom as a buildpack id. (#489)
• Replace builder style functions from Launch with a dedicated LaunchBuilder to be more consistent with other builders in the library. Additionally, all fields of Launch can now be modified via the builder pattern. (#487)
• Rename paths field in launch::Slice to path_globs and add docs to make it clearer that these strings are Go standard library globs. (#487)
• Add explicit DeleteLayerError to provide more context when debugging layer handling problems. (#488)

Fixed

• Fix BuildpackApi to use u64 instead of u32 for major and minor version parts. (#489)
• Fix permission issues during layer handling when the layer contains read-only directories. (#488)

Added

• Add BuildResultBuilder::build_sbom, BuildResultBuilder::launch_sbom and LayerResultBuilder::sbom to enable buildpack authors to attach SBOM data for layers and launch. (#489)
• Add sbom::SbomFormat, describing supported SBOM formats. (#489)
• Add Buildpack::sbom_formats field. (#489)
• Add support for setting a working directory for launch processes. (#489)
• Add TestContext::download_sbom_files to allow testing of SBOM logic. (#489)

Removed

• Remove support for legacy BOM. Remove Launch::bom, Build::bom, bom::Bom, bom::Entry. (#489)