Scala CNB (#430)

* Scala CNB The initial implementation for the Scala CNB. * [GUS epics/work report](https://gus.lightning.force.com/lightning/r/ADM_Epic__c/a3QEE0000002X7x2AE/related/Work__r/view) (internal) * Upstream Cloud Native Buildpacks information * https://buildpacks.io/docs/ * https://github.com/buildpacks/spec/blob/main/buildpack.md * [libcnb.rs documentation](https://docs.rs/libcnb/latest/libcnb/) * Prior art: * https://github.com/heroku/heroku-buildpack-scala (the classic Heroku Scala buildpack) * Other `libcnb.rs`-based Heroku CNBs * https://github.com/heroku/buildpacks-go * https://github.com/heroku/buildpacks-nodejs * https://github.com/heroku/procfile-cnb * Scala CNB The initial implementation for the Scala CNB. * [GUS epics/work report](https://gus.lightning.force.com/lightning/r/ADM_Epic__c/a3QEE0000002X7x2AE/related/Work__r/view) (internal) * Upstream Cloud Native Buildpacks information * https://buildpacks.io/docs/ * https://github.com/buildpacks/spec/blob/main/buildpack.md * [libcnb.rs documentation](https://docs.rs/libcnb/latest/libcnb/) * Prior art: * https://github.com/heroku/heroku-buildpack-scala (the classic Heroku Scala buildpack) * Other `libcnb.rs`-based Heroku CNBs * https://github.com/heroku/buildpacks-go * https://github.com/heroku/buildpacks-nodejs * https://github.com/heroku/procfile-cnb * Scala CNB The initial implementation for the Scala CNB. * [GUS epics/work report](https://gus.lightning.force.com/lightning/r/ADM_Epic__c/a3QEE0000002X7x2AE/related/Work__r/view) (internal) * Upstream Cloud Native Buildpacks information * https://buildpacks.io/docs/ * https://github.com/buildpacks/spec/blob/main/buildpack.md * [libcnb.rs documentation](https://docs.rs/libcnb/latest/libcnb/) * Prior art: * https://github.com/heroku/heroku-buildpack-scala (the classic Heroku Scala buildpack) * Other `libcnb.rs`-based Heroku CNBs * https://github.com/heroku/buildpacks-go * https://github.com/heroku/buildpacks-nodejs * https://github.com/heroku/procfile-cnb * Scala CNB The initial implementation for the Scala CNB. * [GUS epics/work report](https://gus.lightning.force.com/lightning/r/ADM_Epic__c/a3QEE0000002X7x2AE/related/Work__r/view) (internal) * Upstream Cloud Native Buildpacks information * https://buildpacks.io/docs/ * https://github.com/buildpacks/spec/blob/main/buildpack.md * [libcnb.rs documentation](https://docs.rs/libcnb/latest/libcnb/) * Prior art: * https://github.com/heroku/heroku-buildpack-scala (the classic Heroku Scala buildpack) * Other `libcnb.rs`-based Heroku CNBs * https://github.com/heroku/buildpacks-go * https://github.com/heroku/buildpacks-nodejs * https://github.com/heroku/procfile-cnb * Scala CNB The initial implementation for the Scala CNB. * [GUS epics/work report](https://gus.lightning.force.com/lightning/r/ADM_Epic__c/a3QEE0000002X7x2AE/related/Work__r/view) (internal) * Upstream Cloud Native Buildpacks information * https://buildpacks.io/docs/ * https://github.com/buildpacks/spec/blob/main/buildpack.md * [libcnb.rs documentation](https://docs.rs/libcnb/latest/libcnb/) * Prior art: * https://github.com/heroku/heroku-buildpack-scala (the classic Heroku Scala buildpack) * Other `libcnb.rs`-based Heroku CNBs * https://github.com/heroku/buildpacks-go * https://github.com/heroku/buildpacks-nodejs * https://github.com/heroku/procfile-cnb * Scala CNB The initial implementation for the Scala CNB. * [GUS epics/work report](https://gus.lightning.force.com/lightning/r/ADM_Epic__c/a3QEE0000002X7x2AE/related/Work__r/view) (internal) * Upstream Cloud Native Buildpacks information * https://buildpacks.io/docs/ * https://github.com/buildpacks/spec/blob/main/buildpack.md * [libcnb.rs documentation](https://docs.rs/libcnb/latest/libcnb/) * Prior art: * https://github.com/heroku/heroku-buildpack-scala (the classic Heroku Scala buildpack) * Other `libcnb.rs`-based Heroku CNBs * https://github.com/heroku/buildpacks-go * https://github.com/heroku/buildpacks-nodejs * https://github.com/heroku/procfile-cnb * Scala CNB The initial implementation for the Scala CNB. * [GUS epics/work report](https://gus.lightning.force.com/lightning/r/ADM_Epic__c/a3QEE0000002X7x2AE/related/Work__r/view) (internal) * Upstream Cloud Native Buildpacks information * https://buildpacks.io/docs/ * https://github.com/buildpacks/spec/blob/main/buildpack.md * [libcnb.rs documentation](https://docs.rs/libcnb/latest/libcnb/) * Prior art: * https://github.com/heroku/heroku-buildpack-scala (the classic Heroku Scala buildpack) * Other `libcnb.rs`-based Heroku CNBs * https://github.com/heroku/buildpacks-go * https://github.com/heroku/buildpacks-nodejs * https://github.com/heroku/procfile-cnb * Scala CNB The initial implementation for the Scala CNB. * [GUS epics/work report](https://gus.lightning.force.com/lightning/r/ADM_Epic__c/a3QEE0000002X7x2AE/related/Work__r/view) (internal) * Upstream Cloud Native Buildpacks information * https://buildpacks.io/docs/ * https://github.com/buildpacks/spec/blob/main/buildpack.md * [libcnb.rs documentation](https://docs.rs/libcnb/latest/libcnb/) * Prior art: * https://github.com/heroku/heroku-buildpack-scala (the classic Heroku Scala buildpack) * Other `libcnb.rs`-based Heroku CNBs * https://github.com/heroku/buildpacks-go * https://github.com/heroku/buildpacks-nodejs * https://github.com/heroku/procfile-cnb * Scala CNB The initial implementation for the Scala CNB. * [GUS epics/work report](https://gus.lightning.force.com/lightning/r/ADM_Epic__c/a3QEE0000002X7x2AE/related/Work__r/view) (internal) * Upstream Cloud Native Buildpacks information * https://buildpacks.io/docs/ * https://github.com/buildpacks/spec/blob/main/buildpack.md * [libcnb.rs documentation](https://docs.rs/libcnb/latest/libcnb/) * Prior art: * https://github.com/heroku/heroku-buildpack-scala (the classic Heroku Scala buildpack) * Other `libcnb.rs`-based Heroku CNBs * https://github.com/heroku/buildpacks-go * https://github.com/heroku/buildpacks-nodejs * https://github.com/heroku/procfile-cnb * Scala CNB The initial implementation for the Scala CNB. * [GUS epics/work report](https://gus.lightning.force.com/lightning/r/ADM_Epic__c/a3QEE0000002X7x2AE/related/Work__r/view) (internal) * Upstream Cloud Native Buildpacks information * https://buildpacks.io/docs/ * https://github.com/buildpacks/spec/blob/main/buildpack.md * [libcnb.rs documentation](https://docs.rs/libcnb/latest/libcnb/) * Prior art: * https://github.com/heroku/heroku-buildpack-scala (the classic Heroku Scala buildpack) * Other `libcnb.rs`-based Heroku CNBs * https://github.com/heroku/buildpacks-go * https://github.com/heroku/buildpacks-nodejs * https://github.com/heroku/procfile-cnb * Scala CNB The initial implementation for the Scala CNB. * [GUS epics/work report](https://gus.lightning.force.com/lightning/r/ADM_Epic__c/a3QEE0000002X7x2AE/related/Work__r/view) (internal) * Upstream Cloud Native Buildpacks information * https://buildpacks.io/docs/ * https://github.com/buildpacks/spec/blob/main/buildpack.md * [libcnb.rs documentation](https://docs.rs/libcnb/latest/libcnb/) * Prior art: * https://github.com/heroku/heroku-buildpack-scala (the classic Heroku Scala buildpack) * Other `libcnb.rs`-based Heroku CNBs * https://github.com/heroku/buildpacks-go * https://github.com/heroku/buildpacks-nodejs * https://github.com/heroku/procfile-cnb * Scala CNB The initial implementation for the Scala CNB. * [GUS epics/work report](https://gus.lightning.force.com/lightning/r/ADM_Epic__c/a3QEE0000002X7x2AE/related/Work__r/view) (internal) * Upstream Cloud Native Buildpacks information * https://buildpacks.io/docs/ * https://github.com/buildpacks/spec/blob/main/buildpack.md * [libcnb.rs documentation](https://docs.rs/libcnb/latest/libcnb/) * Prior art: * https://github.com/heroku/heroku-buildpack-scala (the classic Heroku Scala buildpack) * Other `libcnb.rs`-based Heroku CNBs * https://github.com/heroku/buildpacks-go * https://github.com/heroku/buildpacks-nodejs * https://github.com/heroku/procfile-cnb
heroku · Apr 14, 2023 · 85010d3 · 85010d3
1 parent 0ae077e
commit 85010d3
Show file tree

Hide file tree

Showing 56 changed files with 3,548 additions and 0 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -4,6 +4,7 @@ members = [
     "buildpacks/jvm",
     "buildpacks/jvm-function-invoker",
     "buildpacks/maven",
+    "buildpacks/sbt",
 ]
 
 [workspace.package]

diff --git a/buildpacks/sbt/CHANGELOG.md b/buildpacks/sbt/CHANGELOG.md
@@ -0,0 +1,7 @@
+# Changelog
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+* Initial release
diff --git a/buildpacks/sbt/Cargo.toml b/buildpacks/sbt/Cargo.toml
@@ -0,0 +1,22 @@
+[package]
+name = "sbt"
+version.workspace = true
+rust-version.workspace = true
+edition.workspace = true
+publish.workspace = true
+
+[dependencies]
+libcnb.workspace = true
+libherokubuildpack.workspace = true
+indoc = "2"
+java-properties = "1"
+serde = { version = "1", features = ["derive"] }
+tempfile = "3"
+thiserror = "1"
+semver="1"
+shell-words = "1"
+glob = "0.3"
+
+[dev-dependencies]
+libcnb-test.workspace = true
+ureq = "2"
diff --git a/buildpacks/sbt/README.md b/buildpacks/sbt/README.md
@@ -0,0 +1,122 @@
+# Heroku Cloud Native sbt Buildpack
+[![CI](https://github.com/heroku/buildpacks-jvm/actions/workflows/ci.yml/badge.svg)](https://github.com/heroku/buildpacks-jvm/actions/workflows/ci.yml)
+
+Heroku's official Cloud Native Buildpack for [sbt](https://www.scala-sbt.org/) usage in [Scala](https://www.scala-lang.org/) applications.
+
+## How it works
+
+The buildpack will detect if your application requires `sbt` if any one of the following file patterns match:
+- `project/build.properties`
+- `project/*.scala`
+- `*.sbt`
+- `.sbt/*.scala`
+
+### Step 1: Download sbt
+
+An [sbt wrapper script](https://github.com/dwijnand/sbt-extras) is written into its own layer that will contain the sbt
+build tooling. This wrapper script then executes to download the sbt version specified in your `project/build.properties` file.
+
+### Step 2: Run sbt
+
+By default, the [sbt](https://www.scala-sbt.org/index.html) command used to build the application is `sbt compile stage`.
+Applications that require customizations to this process to build successfully should refer to the [Customizing](#customizing)
+section of this document.
+
+## Customizing
+
+This buildpack exposes the following configurable settings. The order they appear in the table indicates their precedence.
+
+> For example, if your application contains:
+> * a `system.properties` file with the `sbt.project` property set
+> * and the environment variable `SBT_PROJECT` is set
+>
+> Then the value from `system.properties` will be used.
+
+### Configure a sbt subproject build
+
+When this setting is configured, the default build tasks will be prepended with the supplied project name. E.g.; the default
+`compile` and `stage` tasks would become `{subproject}/compile` and `{subproject}/stage`.
+
+| From               | Path                | Name          |
+|--------------------|---------------------|---------------|
+| Java property file | `system.properties` | `sbt.project` |
+| Environment        |                     | `SBT_PROJECT` |
+
+### Specify tasks to execute before building
+
+This setting will prepend the supplied tasks to the list of tasks to run during the build. These must be supplied as
+a string of space-separated task names. E.g.; a value of `task1 task2` would cause the build step to be invoked with
+`sbt task1 task2 compile stage`.
+
+| From               | Path                | Name            |
+|--------------------|---------------------|-----------------|
+| Java property file | `system.properties` | `sbt.pre-tasks` |
+| Environment        |                     | `SBT_PRE_TASKS` |
+
+### Specify which build tasks to use
+
+This setting will override the default build tasks of `compile` and `stage`. These must be supplied as
+a string of space-separated task names. E.g.; a value of `mybuild` would cause the build step to be invoked with
+`sbt mybuild`.
+
+| From               | Path                | Name        |
+|--------------------|---------------------|-------------|
+| Java property file | `system.properties` | `sbt.tasks` |
+| Environment        |                     | `SBT_TASKS` |
+
+### Cleaning the project before build
+
+This setting will prepend a `clean` task to before all other tasks to run during the build. This must be supplied as a
+value of either `true` or `false`. E.g.; setting this value to `true` would cause the build step to be invoked with
+`sbt clean compile stage`.
+
+| From               | Path                | Name        |
+|--------------------|---------------------|-------------|
+| Java property file | `system.properties` | `sbt.clean` |
+| Environment        |                     | `SBT_CLEAN` |
+
+### Making sbt available at launch
+
+By default, the `sbt` executable as well as its caches are only available during the build process.  If you need
+`sbt` to launch your application you can configure this setting with a value of `true`.
+
+| From               | Path                | Name                      |
+|--------------------|---------------------|---------------------------|
+| Java property file | `system.properties` | `sbt.available-at-launch` |
+| Environment        |                     | `SBT_AVAILABLE_AT_LAUNCH` |
+
+### Adding custom sbt options
+
+If the `SBT_OPTS` environment variable is defined when sbt starts, its content are passed as command line arguments to
+the JVM running sbt.
+
+If a file named `.sbtopts` exists, its content is appended to `SBT_OPTS`.
+
+When passing options to the underlying sbt JVM, you must prefix them with `-J`. Thus, setting stack size for the compile
+process would look like this:
+
+```sh
+heroku config:set SBT_OPTS="-J-Xss4m"
+```
+
+| From         | Path                | Name       |
+|--------------|---------------------|------------|
+| Environment  |                     | `SBT_OPTS` |
+| Options file | `.sbtopts`          |            |
+
+
+## Build Plan
+
+### Requires
+
+* `jdk`: To compile Java sources a JDK is required. It can be provided by the `heroku/jvm` ([Source](/buildpacks/jvm),
+[Readme](/buildpacks/jvm/README.md)) buildpack.
+* `jvm-application`: This is not a strict requirement of the buildpack. Requiring `jvm-application` ensures that this
+buildpack can be used even when no other buildpack requires `jvm-application`.
+
+### Provides
+
+* `jvm-application`: Allows other buildpacks to depend on a compiled JVM application.
+
+## License
+See [LICENSE](../../LICENSE) file.
diff --git a/buildpacks/sbt/assets/heroku_buildpack_plugin_sbt_v0.scala b/buildpacks/sbt/assets/heroku_buildpack_plugin_sbt_v0.scala
@@ -0,0 +1,10 @@
+import sbt._
+import Keys._
+
+object HerokuBuildpackPlugin extends Plugin {
+  override def settings = Seq(
+    sources in doc in Compile := List(),
+    publishArtifact in packageDoc := false,
+    publishArtifact in packageSrc := false
+  )
+}
diff --git a/buildpacks/sbt/assets/heroku_buildpack_plugin_sbt_v1.scala b/buildpacks/sbt/assets/heroku_buildpack_plugin_sbt_v1.scala
@@ -0,0 +1,10 @@
+import sbt._
+import Keys._
+
+object HerokuBuildpackPlugin extends AutoPlugin {
+  override lazy val projectSettings = Seq(
+    Compile / doc / sources := List(),
+    packageDoc / publishArtifact := false,
+    packageSrc / publishArtifact := false
+  )
+}