search term:

sbt 2.1.0-RC1

Hi everyone. On behalf of the sbt project, I am happy to announce sbt 2.1.0-RC1. This is the beta version of the first feature release of sbt 2.x, a binary compatible release focusing on new features.

The headline features of sbt 2.1.0 are:

The full release note is at https://github.com/sbt/sbt/releases/tag/v2.1.0-RC1. See also sbt 2.0 change summary.

How to upgrade

You can upgrade to sbt 2.1.0-RC1 by putting the following in project/build.properties:

sbt.version=2.1.0-RC1

This mechanism allows that sbt 2.1.0-RC1 is used only for the builds that you want.

Download the official sbt runner from SDKMAN, or download from https://github.com/sbt/sbt/releases/tag/v2.1.0-RC1 to upgrade the sbt shell script, sbtn, and the launcher.

Changes with compatibility implications

Scala 3.9 on metabuild

sbt 2.1.0 updates the Scala version used by the metabuild to Scala 3.9.0.

Since both sbt 2.x and Scala 3.x are only backward compatible across minor versions, appropriate Scala version must be used for building sbt plugins. This also means that a plugin built using sbt 2.1.x will not work on sbt 2.0.x:

sbt 2.x Scala 3.x Plugin works on sbt 2.0.x
2.0.x 3.8.x ✅
2.1.0 3.9.x ❌

Plugin authors: Here’s how to set the minimal sbt version for your plugin:

pluginCrossBuild / sbtVersion := {
  scalaBinaryVersion.value match {
    case "2.12" => "1.9.9"
    case _      => "2.0.8"
  }
}

Publishing

sbt 2.1.0 removes Apache Ivy from its transitive dependency, which was previously used for publishing, and implements Ivyless publishing.

This was contributed by @bitloi, @fury0928, @BrianHotopp, and @eed3si9n in #8686, #8866, #8894, #8975, #8988, #8996, #9069, #9463, #9533, and #9615 etc.

clean task

To restore the semantics of clean in the presence of disk cache, sbt 2.1.0 updates the clean task to act as a cache invalidator. Regardless of the cache state, running clean would invalidate the cache for the next command execution. This can be scoped to subproject or configuration:

$ sbt foo/clean
$ sbt foo/compile

This was contributed by @eed3si9n in #9752.

Test UX improvements

Test summary

When tests are executed, sbt 2.1.0 displays a test summary at the end, listing the failed test suites as follows:

[error] Test summary (2 test tasks failed):
[error]   a / Test / testQuick
[error]         com.example.a.TestA     FAIL
[error]   b / Test / testQuick
[error]         com.example.b.TestB     FAIL
[error]
[error] failed: total 4, failed 2, errors 0, passed 2, cached 2

Successful tests will display only a terse summary by default:

[info] passed: total 4, failed 0, errors 0, passed 4, cached 4

--test_summary=success can override the behavior to list the successful test as well. Test summary was contributed by @eed3si9n and @BrianHotopp in #9602 + #9214.

Test cache opt-out

sbt 2.1.0 can let you opt out of test result caching:

$ sbt test --cache_test_result=false

This was contributed by @anatoliykmetyuk in #9675.

workerMaxInstances and testTopology

sbt 2.1.0 adds new settings workerMaxInstances and testTopology to control test scheduling, especially of the forked tests. Use Global / workerMaxInstances to change the number of worker instances. The default is set to 2:

// or sbt -Dsbt.worker_max_instances=2
Global / workerMaxInstances := 2

Use the testTopology setting to control whether you want to split the test classes into multiple workers or keep them together. The default was changed to split to 2 groups:

Test / testTopology := TestTopology.subprojectSplit(2)

To keep all classes in a subproject on one worker instead, use:

Test / testTopology := TestTopology.subprojectExclusive

This was contributed by @eed3si9n in #9665.

Source dependency update

sbt 2.1.0 provides better control to handle source dependencies.

This was contributed by @seroperson in #8880.

Identity map optimization

In sbt 2.1.0, a key assignment (:=) whose right-hand side is expr.value short-circuits to x.set(expr). This is helpful in avoiding JsonFormat[A] when expr is an uncached task.

This was contributed by @eed3si9n in #9831

Task-level caching opt-out

// opt out of compilation cache
Compile / compile / cacheStores := Nil
Test / compile / cacheStores := Nil

// opt out of test cache
Test / test / cacheStores := Nil

This was contributed by @eed3si9n in #9874

HTTP Bazel cache

sbt 2.1.0 adds support for HTTP Bazel cache, in addition to gPRC.

Global / remoteCache := Some(uri("http://127.0.0.1:8000"))

This was contributed by @eed3si9n in #9880

⚡ Performance improvements

🚀 Other updates

🐛 Bug fixes

90+ bug fixes. See https://github.com/sbt/sbt/releases/tag/v2.1.0-RC1.

Participation

sbt 2.1.0-RC1 was brought to you by 55 contributors: Eugene Yokota (eed3si9n), Kenji Yoshida (xuwei-k), BrianHotopp, Anatolii Kmetiuk, Albert Meltzer, Dream, Stas Shevchenko, bitloi, Mai Huy Hoàng, BitToby, Daniil Sivak, Jozef Koval, Matthias Kurz, Matt Dziuban, corevibe555, it-education-md, Ali Rashid, Christian Harrington, Merlin Hughes, Michał Pawlik, PandaMan, PhoenixmitX, Renzo, Rikito Taniguchi, Yannick Heiber, azdrojowa123, oolokioo7, Alexander (alexasl), Angel98518, BinaryWorldTl, BitCompass, Clayton, Dmitrii Naumenko, Eugene (eugkhp), Fabrizio Colonna, Full Stack Developer (jsdevninja), Idan Ben-Zvi, Ivan Stanislavciuc, Jason Zaugg, Jonathan Chang, Kevin Lee, KilianSwissborg, Michał Pierściński, Philippus Baalman, Viktor Rudebeck, Zainab Ali, atoz96, chrisrock1124, ckstck, dev-miro26, fireXtract, jimcody1995, since-2017-hub, tanaka takaya, and volcano303. Thank you! Thanks to everyone who’s helped improve sbt and Zinc by using them, reporting bugs, improving our documentation, porting builds, porting plugins, and submitting and reviewing pull requests.

For anyone interested in helping sbt, there are many avenues for you to help, depending on your interest. If you’re interested, Contributing, “help wanted”, “good first issue”, and Discussions are good starting points.