« Changelog History


sbt v1.4.0 Release Notes

Release Date: 2020-10-05 // over 3 years ago

  • The headline features of sbt 1.4.0 are:

    • 🏗 build server protocol (BSP) support
    • sbtn: a native thin client for sbt
    • 🏗 build caching
    • ⚠ ThisBuild / versionScheme to take the guessing out of eviction warning

    ⬆️ How to upgrade

    Download the official sbt launcher from SDKMAN or download from https://www.scala-sbt.org/download.html. This installer includes the sbtn binary.

    ⬆️ In addition, the sbt version used for your build is upgraded by putting the following in project/build.properties:

    sbt.version=1.4.0

    🏗 This mechanism allows that sbt 1.4.0 is used only for the builds that you want.

    🏗 Build server protocol (BSP) support

    🏗 sbt 1.4.0 adds build server protocol (BSP) support, contributed by Scala Center. Main implementation was done by Adrien Piquerez (@adpi2) based on @eed3si9n's prototype.

    🏗 When sbt 1.4.0 starts, it will create a file named .bsp/sbt.json containing a machine-readable instruction on how to run sbt -bsp, which is a command line program that uses standard input and output to communicate to sbt server using build server protocol.

    How to import to IntelliJ using BSP

    1. Start sbt in a terminal
    2. Open IntelliJ IDEA 2020.1.2 or later
    3. Select "Open or import", and select "BSP Project"

    How to import to VS Code + Metals

    1. Delete existing .bsp, .metals, .bloop directories if any
    2. Open VS Code in the working directory
    3. Ignore the prompt to import the project
    4. Start sbt -Dsbt.semanticdb=true in the Terminal tab. Wait till it displays "sbt server started" 🏗 5. Navigate to Metals view, and select "Restart build server"
    5. Type compile into the sbt session to generate SemanticDB files

    #5538/#5443 by @adpi2

    Native thin client

    👍 sbt 1.4.0 adds an official native thin client called sbtn that supports all tasks. If you're using the official sbt launcher 1.4.0 and not the knockoff kind you can use --client option to run the native thin client:

    $ sbt --client compile $ sbt --client shutdown

    The native thin client will run sbt (server) as a daemon, which avoids the JVM spinup and loading time for the second call onwards. This could an option if you would like to use sbt from the system shell such as Zsh and Fish.

    Remember to call sbt --client shutdown when you're done!
    🚀 sbtn binary files are also available from https://github.com/sbt/sbtn-dist/releases/tag/v1.4.0

    #5620 by @eatkins

    ThisBuild / versionScheme

    🏗 sbt 1.4.0 adds a new setting called ThisBuild / versionScheme to track version scheme of the build:

    ThisBuild / versionScheme := Some("early-semver")

    ⚠ The supported values are "early-semver", "pvp", and "semver-spec". sbt will include this information into pom.xml and ivy.xml as a property. In addition, sbt 1.4.0 will use the information to take the guessing out of eviction warning when this information is available. #5724 by @eed3si9n

    VirtualFile + RemoteCache

    sbt 1.4.0 / Zinc 1.4.0 virtualizes the file paths tracked during incremental compilation. The benefit for this that the state of incremental compilation can shared across different machines, as long as ThisBuild / rootPaths are enumerated beforehand.

    To demonstrate this, we've also added experimental cached compilation feature to sbt. All you need is the following setting:

    ThisBuild / pushRemoteCacheTo := Some(MavenCache("local-cache", file("/tmp/remote-cache")))

    Then from machine 1, call pushRemoteCache. This will publish the *.class and Zinc Analysis artifacts to the location. Next, from machine 2, call pullRemoteCache.

    zinc#712/#5417 by @eed3si9n

    👕 Build linting

    👕 On start up, sbt 1.4.0 checks for unused settings/tasks. Because most settings are on the intermediary to other settings/tasks, they are included into the linting by default. The notable exceptions are settings used exclusively by a command. To opt-out, you can either append it to Global / excludeLintKeys or set the rank to invisible.

    #5153 by @eed3si9n

    Conditional task

    👍 sbt 1.4.0 adds support for conditional task (or Selective task), which is a new kind of task automatically created when Def.task { ... } consists of an if-expression:

    bar := { if (number.value \< 0) negAction.value else if (number.value == 0) zeroAction.value else posAction.value }

    👀 Unlike the regular (Applicative) task composition, conditional tasks delays the evaluation of then-clause and else-clause as naturally expected of an if-expression. This is already possible with Def.taskDyn { ... }, but unlike dynamic tasks, conditional task works with inspect command. See Selective functor for sbt for more details. #5558 by @eed3si9n

    🏗 Incremental build pipelining

    🏗 sbt 1.4.0 adds experimental incremental build pipelining. To enable build pipelining for the build:

    ThisBuild / usePipelining := true

    To opt-out of creating an early output for some of the subprojects:

    exportPipelining := false

    #5703 by @eed3si9n

    sbt-dependency-graph is in-sourced

    🔌 sbt 1.4.0 brings in Johannes Rudolph's sbt-dependency-graph plugin into the code base.
    🔌 Since it injects many tasks per subprojects, the plugin is split into two parts:

    • 🔧 MiniDependencyTreePlugin that is enabled by default, bringing in dependencyTree task to Compile and Test configurations

    • 🔌 Full strength DependencyTreePlugin that is enabled by putting the following to project/plugins.sbt:

      addDependencyTreePlugin

    🛠 Fixes with compatibility implications

    • 0️⃣ Replaces Apache Log4j with our own logger by default to avoid Appender leakage. Use ThisBuild / useLog4J := true to use Log4j. #5731 by @eatkins
    • 👉 Makes JAR file creation repeatable by sorting entry by name and dropping timestamps #5344/io#279 by @raboof
    • 🏗 Loads bare settings in the alphabetic order of the build files #2697/#5447 by @eed3si9n
    • 🏗 Loads vals from top-to-bottom within a build file #2232/#5448 by @eed3si9n
    • HTTP resolvers require explicit opt-in using .withAllowInsecureProtocol(true) #5593 by @eed3si9n
    • Ctrl-C during triggered execution ~ returns to the shell instead of shutting down sbt #5804 by @eatkins

    ⚡️ Other updates

    • ⚡️ Updates shell to use JLine 3 for better tab completion #5671 by @eatkins
    • ➕ Adds support for Scala 2.13-3.0 sandwich #5767 by @eed3si9n
    • Throws an error if you run sbt from / without -Dsbt.rootdir=true #5112 by @eed3si9n
    • Upates StateTransform to accept State => State #5260 by @eatkins
    • 🛠 Fixes various issues around background run #5259 by @eatkins
    • Turns off supershell when TERM is set to "dumb" #5278 by @hvesalai
    • 🌲 Avoids using system temporary directories for logging #5289 by @eatkins
    • ➕ Adds library endpoint for sbt.ForkMain #5315 by @olafurpg
    • Avoids using last modified time of directories to invalidate doc #5362 by @eatkins
    • 🛠 Fixes the default artifact of packageSrc for custom configuration #5403 by @eed3si9n
    • 🛠 Fixes task cancellation handling #5446/zinc#742 by @azolotko
    • ➕ Adds toTaskable method injection to Initialize[A] for tuple syntax #5439 by @dwijnand
    • 🛠 Fixes the error message for an undefined setting #5469 by @nigredo-tori
    • ⚡️ Updates semanticdbVersion to 4.3.7 #5481 by @anilkumarmyla
    • ➕ Adds Tracked.outputChangedW and Tracked.inputChangedW which requires typeclass evidence of JsonWriter[A] instead of JsonFormat[A] #5513 by @bjaglin
    • 🛠 Fixes various supershell interferences #5319 by @eatkins
    • ➕ Adds extension methods to State to faciliate sbt server communication #5207 by @eed3si9n
    • ➕ Adds support for weighed tags for testGrouping #5527 by @frosforever
    • ⚡️ Updates to sjson-new, which shades Jawn 1.0.0 #5595 by @eed3si9n
    • 🛠 Fixes NullPointerError when credential realm is null #5526 by @3rwww1
    • ➕ Adds Def.promise for long-running tasks to communicate to another task #5552 by @eed3si9n
    • 👉 Uses Java's timestamp on JDK 10+ as opposed to using native call io#274 by @slandelle
    • ➕ Adds retry with backoff during publish (-Dsbt.repository.publish.attempts set to 3) lm#340 by @izharahmd
    • 👌 Improves failure message for PUT lm#309 by @swaldman
    • ➕ Adds provenance to AnalyzedClass zinc#786 by @dwijnand + @mspnf
    • 👉 Makes hashing childrenOfSealedClass stable zinc#788 by @dwijnand
    • 🛠 Fixes performance regressions around build source monitoring #5530 by @eatkins
    • 🛠 Fixes performance regressions around super shell #5531 by @eatkins
    • 🐎 Various performance improvements in Zinc zinc#756/zinc#763 by @retronym
    • ➕ Adds a monitor to warn about excessive GC #5812 by @eatkins
    • 🛠 Fixes forked tests running tests twice when they match multiple fingerprints #5800 by @Duhemm

    Participation

    sbt 1.4.0 was brought to you by 34 contributors. Ethan Atkins, Eugene Yokota (eed3si9n), Johannes Rudolph, Dale Wijnand, Adrien Piquerez, Jason Zaugg, Arnout Engelen, Josh Soref, Guillaume Martres, Maksim Ochenashko, Anil Kumar Myla, Brice Jaglin, Claudio Bley, João Ferreira, Steve Waldman, frosforever, Alex Zolotko, Heikki Vesalainen, Ismael Juma, Stephane Landelle, Jannik Theiß, izharahmd, lloydmeta, Alexandre Archambault, Eric Peters, Erwan Queffelec, Kenji Yoshida (xuwei-k), Martin Duhem, Olafur Pall Geirsson, Renato Cavalcanti, Vincent PERICART, nigredo-tori. Thanks!

    📚 Thanks to everyone who's helped improve sbt and Zinc 1 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" are good starting points.

    🔌 Note to plugin authors

    ⬆️ If you build and publish a plugin using sbt 1.4.0, your users will also be forced to upgrade to sbt 1.4.0 immediately. To prevent this you can cross build your plugin against sbt 1.2.8 (while using sbt 1.4.0) as follows:

    pluginCrossBuild / sbtVersion := "1.2.8"

    Appendix

    ✅ To test sbt server manually, make sure to have an sbt session running, and start sbt -bsp in another termnial. And paste the following in:

    { "jsonrpc": "2.0", "id": 1, "method": "build/initialize", "params": { "displayName": "foo", "version": "1.0.0", "bspVersion": "2.0.0-M5", "rootUri": "file:///tmp/hello", "capabilities": { "languageIds": ["scala"] } } }

    Then enter \r\n (type Enter, Ctrl-J for zsh). This should return:

    Content-Length: 200
Content-Type: application/vscode-jsonrpc; charset=utf-8

{"jsonrpc":"2.0","id":1,"result":{"displayName":"sbt","version":"1.4.0-SNAPSHOT","bspVersion":"2.0.0-M5","capabilities":{"compileProvider":{"languageIds":["scala"]},"dependencySourcesProvider":true}}}