Provide docs how to use the plugin with multi-project projects

[Bohtvaroh]

Hi, Josh. I try to use this plugin with multi-project setup described in your book "SBT in Action" (btw, I can't skip dots at the end of the lines like in the book - it doesn't compile).

My build.sbt:

import dependencies._
import common._

packageArchetype.java_application

name := "CoolProject"

lazy val common = (
  DefProject("common").
  settings(libraryDependencies ++= commonDependencies)
)

lazy val backend = (
  DefProject("backend").
  dependsOn(common).
  settings(libraryDependencies ++= backendDependencies)
)

lazy val frontend = (
  DefProject("frontend").
  dependsOn(backend).
  settings(libraryDependencies ++= frontendDependencies)
)

common.scala:

import sbt._
import Keys._

object common {
  val commonSettings = Seq(
    organization := "com.example",
    organizationName := "AwesomeOrg",
    version := "0.1-SNAPSHOT",

    scalaVersion := "2.10.3",
    scalacOptions ++= Seq("-feature", "-unchecked", "-encoding", "utf8"),

    resolvers ++= Seq(
      "Typesafe repository" at "http://repo.typesafe.com/typesafe/releases/"
    )
  )

  def DefProject(name: String): Project = {
    Project(name, file(name)).
    settings(commonSettings: _*)
  }
}

and dependencies.scala:

import sbt._

object dependencies {
  // versions
  val scalaARMVersion = "1.3"

  val jodaTimeVersion = "2.3"
  val jodaConvertVersion = "1.2"

  val apachePOIVersion = "3.9"

  val reactiveMongoVersion = "0.9"

  val scalaTestVersion = "1.9.1"
  val scalaCheckVersion = "1.10.1"

  // libraries
  val scalaARM = "com.jsuereth" %% "scala-arm" % scalaARMVersion

  val jodaTime = "joda-time" % "joda-time" % jodaTimeVersion
  val jodaConvert = "org.joda" % "joda-convert" % jodaConvertVersion

  val apachePOI = "org.apache.poi" % "poi-scratchpad" % apachePOIVersion

  val reactiveMongo = "org.reactivemongo" %% "reactivemongo" % reactiveMongoVersion

  val scalaTest = "org.scalatest" %% "scalatest" % scalaTestVersion
  val scalaCheck = "org.scalacheck" %% "scalacheck" % scalaCheckVersion

  // projects
  val commonDependencies = Seq(
    scalaTest % "test", scalaCheck % "test"
  )

  val backendDependencies = commonDependencies ++ Seq(
    scalaARM,

    jodaTime, jodaConvert,

    apachePOI,

    reactiveMongo
  )

  val frontendDependencies = commonDependencies ++ Seq(
  )
}

But when I invoke 'stage' from the root I don't get my sub-projects and their dependencies. I just want to include all my sub-projects. Can you provide some documentation describing this plugin usage in such a common scenario? Thank you so much for your book and this plugin!

[jsuereth]

I'll try to detail this out soon.

Basically, the "archetypes" are a per-project based packaging scenario. If you want to package multiple projects, you may need to "manually" construct the mappings in Universal that aggregates all your sub-projects and then use the mechanism to create native packages from these.

I'll see if perhaps I can promote that idea as first class.

[Bohtvaroh]

Josh, it would be very nice to support this idea as first class. It's common to have frontend, backend, common sub-projects and wish to merge them together into a single package without too much pain.

For now, can you provide some steps or code required to construct this setup manually?

Thanks you.

[muuki88]

I think we should put this in our next milestone 0.8.0

[jsuereth]

sounds good. Sorry I've been AFK, trying to push 0.13.2-RC1 out.

[ogirardot]

bump :)
any news on that, i'm trying to do pretty much that (by merging native packager result on subprojects for the master project).

[muuki88]

Not from me :( I'm currently not having that much experience with multi-module-sbt projects. I'm doing this currently with a configuration like this

  lazy val frontend = Project(
    id = "frontend",
    base = file("."),
    settings = defaultSettings ++ playScalaSettings ++ packageArchetype.java_server ++ Packaging.debian ++ Seq(
      libraryDependencies ++= Dependencies.frontend
    ),
    aggregate = Seq(common, api)
  ) dependsOn(common, api)


  // --------- Project Commons ----------------
  lazy val common = Project(
    id = "common",
    base = file("sub_common"),
    settings = defaultSettings ++ Seq(
      libraryDependencies ++= Dependencies.common
    )
  )

  // --------- Project API ------------------
  lazy val api = Project(
    id = "api",
    base = file("sub_api"),
    settings = defaultSettings ++ Seq(
      libraryDependencies ++= Dependencies.common
    )
  ) dependsOn(common)

[jsuereth]

Yeah, so we only support "whole" packages right now, with all dependent jars bundles, and no sharing. It'd be an epic feature request to do more, and possibly some socialization of how to do so.

Otherwise @muuki88's code looks great except for that defaultSettings bit :). Using defaultSettings is effectively deprecated in 0.13.5 (as it means you're going to bypass the entire AutoPlugin mechanism), so here's what I would write:

lazy val frontend = (Project(
    id = "frontend",
    base = file("."),
    aggregate = Seq(common, api)
  )  settings(playScalaSettings:_*)
     settings(packageArchetype.java_server:_*) settings(
      libraryDependencies ++= Dependencies.frontend
  ),dependsOn(common, api))


  // --------- Project Commons ----------------
  lazy val common = Project(
    id = "common",
    base = file("sub_common")
   ) settings(
      libraryDependencies ++= Dependencies.common
    )
  )

  // --------- Project API ------------------
  lazy val api = Project(
    id = "api",
    base = file("sub_api"),
  ) settings (
      libraryDependencies ++= Dependencies.common
    )
  ) dependsOn(common)