diff --git a/NOTICE b/NOTICE index 5f03cfd..fe61530 100644 --- a/NOTICE +++ b/NOTICE @@ -1,4 +1,4 @@ -leiningen +clojure-tools Copyright (c) 2020-Present CloudFoundry.org Foundation, Inc. All Rights Reserved. diff --git a/README.md b/README.md index 18af6fd..30487a1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ -# Paketo Buildpack for Clojure Tools +# `gcr.io/paketo-buildpacks/clojure-tools` The Paketo Clojure Tools Buildpack is a Cloud Native Buildpack that builds Clojure-based applications from source. ## Behavior + This buildpack will participate all the following conditions are met * `/deps.edn` exists @@ -18,11 +19,27 @@ The buildpack will do the following: * Expands `/target/*.jar` to `` ## Configuration -| Environment Variable | Description -| -------------------- | ----------- -| `$BP_CLJ_TOOLS_BUILD_ENABLED` | Configure the arguments to enable tools build. -| `$BP_CLJ_TOOLS_BUILD_ARGUMENTS` | Configure the arguments to pass to build system. Defaults to `-T:build uber`. -| `$BP_CLJ_DEPS_ARGUMENTS` | Configure the arguments to pass to build system. Defaults to `-X:uberjar`. -| `$BP_CLJ_BUILT_MODULE` | Configure the module to find application artifact in. Defaults to the root module (empty). -| `$BP_CLJ_BUILT_ARTIFACT` | Configure the built application artifact explicitly. Supersedes `$BP_CLJ_BUILT_MODULE` Defaults to `target/*.jar`. +| Environment Variable | Description | +| ------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `$BP_CLJ_TOOLS_BUILD_ENABLED` | Configure the arguments to enable tools build. | +| `$BP_CLJ_TOOLS_BUILD_ARGUMENTS` | Configure the arguments to pass to build system. Defaults to `-T:build uber`. | +| `$BP_CLJ_DEPS_ARGUMENTS` | Configure the arguments to pass to build system. Defaults to `-X:uberjar`. | +| `$BP_CLJ_BUILT_MODULE` | Configure the module to find application artifact in. Defaults to the root module (empty). | +| `$BP_CLJ_BUILT_ARTIFACT` | Configure the built application artifact explicitly. Supersedes `$BP_CLJ_BUILT_MODULE` Defaults to `target/*.jar`. | + +## Bindings + +The buildpack optionally accepts the following bindings: + +### Type: `dependency-mapping` + +| Key | Value | Description | +| --------------------- | ------- | ------------------------------------------------------------------------------------------------- | +| `` | `` | If needed, the buildpack will fetch the dependency with digest `` from `` | + +## License + +This buildpack is released under version 2.0 of the [Apache License][a]. + +[a]: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/buildpack.toml b/buildpack.toml index abe6350..308e23a 100644 --- a/buildpack.toml +++ b/buildpack.toml @@ -72,6 +72,10 @@ uri = "https://download.clojure.org/install/linux-install-1.10.3.943.sh" sha256 = "f1fdb786fa8b9ef3a08d0b331a51861cd5a6eea277e93bbad64bf37774df17c6" stacks = [ "io.buildpacks.stacks.bionic", "io.paketo.stacks.tiny", "org.cloudfoundry.stacks.cflinuxfs3" ] + [[metadata.dependencies.licenses]] + type = "Eclipse Public License - v 1.0" + uri = "https://github.com/clojure/clojure/blob/master/epl-v10.html" + [metadata] pre-package = "scripts/build.sh" include-files = [