scalasbtsbt-buildinfo

Can I access my Scala app's name and version (as set in SBT) from code?


I am building an app with SBT (0.11.0) using a Scala build definition like so:

object MyAppBuild extends Build {

  import Dependencies._

  lazy val basicSettings = Seq[Setting[_]](
    organization  := "com.my",
    version       := "0.1",
    description   := "Blah",
    scalaVersion  := "2.9.1",
    scalacOptions := Seq("-deprecation", "-encoding", "utf8"),
    resolvers     ++= Dependencies.resolutionRepos
  )

  lazy val myAppProject = Project("my-app-name", file("."))
    .settings(basicSettings: _*)
    [...]

I'm packaging a .jar at the end of the process.

My question is a simple one: is there a way of accessing the application's name ("my-app-name") and version ("0.1") programmatically from my Scala code? I don't want to repeat them in two places if I can help it.

Any guidance greatly appreciated!


Solution

  • sbt-buildinfo

    I just wrote sbt-buildinfo. After installing the plugin:

    lazy val root = (project in file(".")).
      enablePlugins(BuildInfoPlugin).
      settings(
        buildInfoKeys := Seq[BuildInfoKey](name, version, scalaVersion, sbtVersion),
        buildInfoPackage := "foo"
      )
    

    Edit: The above snippet has been updated to reflect more recent version of sbt-buildinfo.

    It generates foo.BuildInfo object with any setting you want by customizing buildInfoKeys.

    Ad-hoc approach

    I've been meaning to make a plugin for this, (I wrote it) but here's a quick script to generate a file:

    sourceGenerators in Compile <+= (sourceManaged in Compile, version, name) map { (d, v, n) =>
      val file = d / "info.scala"
      IO.write(file, """package foo
        |object Info {
        |  val version = "%s"
        |  val name = "%s"
        |}
        |""".stripMargin.format(v, n))
      Seq(file)
    }
    

    You can get your version as foo.Info.version.