Skip to content

Releases: heroku/libcnb.rs

v0.13.0

17 Jul 21:49
868e6f3
Compare
Choose a tag to compare

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

28 Apr 11:46
bc86099
Compare
Choose a tag to compare

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

07 Feb 17:17
07585c5
Compare
Choose a tag to compare

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

11 Jan 17:10
8766563
Compare
Choose a tag to compare

Added

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

v0.11.3

09 Jan 15:20
fa679ea
Compare
Choose a tag to compare

Added

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

v0.11.2

15 Dec 11:27
47daf61
Compare
Choose a tag to compare

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

29 Sep 09:49
d3e1d07
Compare
Choose a tag to compare

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

23 Sep 12:30
4bc237c
Compare
Choose a tag to compare

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

31 Aug 13:12
3a82376
Compare
Choose a tag to compare

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)

libcnb-test v0.6.0

21 Jul 18:38
d650452
Compare
Choose a tag to compare
  • Overhaul the crate README/docs, to improve the learning/onboarding UX. (#478)
  • Rename TestRunner::run_test to TestRunner::build, TestConfig to BuildConfig and TestContext::run_test to TestContext::rebuild. (#470)
  • Add TestContext::start_container, TestContext::run_shell_command and ContainerConfig. (#469)
  • Remove TestContext::prepare_container and PrepareContainerContext. To start a container use TestContext::start_container combined with ContainerConfig (or else the convenience function TestContext::run_shell_command) instead. (#469)
  • Fix missing logs when using ContainerContext::logs_now. (#471)