clojure-tools

README

gcr.io/paketo-buildpacks/clojure-tools

The Paketo Buildpack for Clojure Tools is a Cloud Native Buildpack that builds Clojure-based applications from source.

Behavior

This buildpack will participate all the following conditions are met

• <APPLICATION_ROOT>/deps.edn exists

The buildpack will do the following:

• Requests that a JDK be installed
• Links the ~/.m2 to a layer for caching
• If <APPLICATION_ROOT>/deps.edn exists
  • Contributes Clojure Tools to a layer with all commands on $PATH
  • Runs <CLOJURE_TOOLS_ROOT>/clojure -X:uberjar to build the application
• Removes the source code in <APPLICATION_ROOT>, following include/exclude rules
• If $BP_CLJ_BUILT_ARTIFACT matched a single file
  • Restores $BP_CLJ_BUILT_ARTIFACT from the layer, expands the single file to <APPLICATION_ROOT>
• If $BP_CLJ_BUILT_ARTIFACT matched a directory or multiple files
  • Restores the files matched by $BP_CLJ_BUILT_ARTIFACT to <APPLICATION_ROOT>

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. Can match a single file, multiple files or a directory. Can be one or more space separated patterns.
$BP_INCLUDE_FILES	Colon separated list of glob patterns to match source files. Any matched file will be retained in the final image. Defaults to `` (i.e. nothing).
$BP_EXCLUDE_FILES	Colon separated list of glob patterns to match source files. Any matched file will be specifically removed from the final image. If include patterns are also specified, then they are applied first and exclude patterns can be used to further reduce the fileset.

Bindings

The buildpack optionally accepts the following bindings:

Type: dependency-mapping

Key	Value	Description
<dependency-digest>	<uri>	If needed, the buildpack will fetch the dependency with digest <dependency-digest> from <uri>

License

This buildpack is released under version 2.0 of the Apache License.