Search code examples
deploymentjarsbtsbt-assembly

How do I publish a fat JAR (JAR with dependencies) using sbt and sbt-release?


I need to build a single jar, including dependencies, for one of my sub-projects so that it can be used as a javaagent.

I have a multi-module sbt project and this particular module is the lowest level one (it's also pure Java).

Can I (e.g. with sbt-onejar, sbt-proguard or sbt assembly) override how the lowest level module is packaged?

It looks like these tools are really designed to be a post-publish step, but I really need a (replacement or additional) published artefact to include the dependencies (but only for this one module).

UPDATE: Publishing for sbt-assembly are instructions for a single project, and doesn't easily translate into multi-project.


Solution

  • Publishing for sbt-assembly are instructions for a single project, and doesn't easily translate into multi-project.

    People have been publishing fat JAR using sbt-assembly & sbt-release without issues. Here's a blog article from 2011: Publishing fat jar created by sbt-assembly. It boils down to adding addArtifact(Artifact(projectName, "assembly"), sbtassembly.AssemblyKeys.assembly) to your build.sbt (note that the blog is a little out of date AssemblyKeys is now a member of sbtassembly directly).

    For sbt 0.13 and above, I prefer to use build.sbt for multi-projects too, so I'd write it like:

    import AssemblyKeys._
    
    lazy val commonSettings = Seq(
      version := "0.1-SNAPSHOT",
      organization := "com.example",
      scalaVersion := "2.10.1"
    )
    
    val app = (project in file("app")).
      settings(commonSettings: _*).
      settings(assemblySettings: _*).
      settings(
        artifact in (Compile, assembly) ~= { art =>
          art.copy(`classifier` = Some("assembly"))
        }
      ).
      settings(addArtifact(artifact in (Compile, assembly), assembly).settings: _*)
    

    See Defining custom artifacts:

    addArtifact returns a sequence of settings (wrapped in a SettingsDefinition). In a full build configuration, usage looks like:

    ...
    lazy val proj = Project(...)
      .settings( addArtifact(...).settings : _* )
    ...