SBT z numerem wersji w programie

Question

Chcę, aby program, który buduję, mógł zgłaszać własną wersję w czasie wykonywania (na przykład scala myprog.jar --version). Tradycyjnie w projekcie maven używam filtrowania zasobów (pom.xml -> file.properties -> read value w czasie wykonywania). Wiem, że jest sbt-filter-plugin, aby emulować tę funkcjonalność, ale jestem ciekawy, czy istnieje bardziej standardowy/preferowany/sprytny sposób robienia tego w SBT.

tl; dr jak mogę odczytać numer wersji zdefiniowany w build.sbt w czasie wykonywania?

Answer 1

Aktualizacja ...

https://github.com/ritschwumm/xsbt-reflect (wymienione powyżej) jest przestarzała, ale nie jest to fajne narzędzie uwolnienie SBT, który może automatycznie zarządzać wersjami i nie tylko: https://github.com/sbt/sbt-release.

Ewentualnie, jeśli chcesz szybko naprawić można dostać wersję z manifestu tak:

val version: String = getClass.getPackage.getImplementationVersion 

Ta wartość będzie równa version ustawienia w projekcie, które można ustawić zarówno w build.sbt lub Build.scala.

Kolejna aktualizacja ...

Buildinfo SBT Wtyczka może wygenerować klasę z numerem wersji opartej na build.sbt:

/** This object was generated by sbt-buildinfo. */ 
case object BuildInfo { 
    /** The value is "helloworld". */ 
    val name: String = "helloworld" 
    /** The value is "0.1-SNAPSHOT". */ 
    val version: String = "0.1-SNAPSHOT" 
    /** The value is "2.10.3". */ 
    val scalaVersion: String = "2.10.3" 
    /** The value is "0.13.2". */ 
    val sbtVersion: String = "0.13.2" 
    override val toString: String = "name: %s, version: %s, scalaVersion: %s, sbtVersion: %s" format (name, version, scalaVersion, sbtVersion) 
} 

Zobacz docs na jak włączyć go tutaj: https://github.com/sbt/sbt-buildinfo/.

Answer 2

Użyj wtyczki xsbt-reflect. Wygeneruje plik źródłowy zawierający między innymi numer wersji projektu.

Answer 3

Skończyłem, tworząc system kompilacji (używam Makefile na szczycie sbt) przygotować plik src/main/resources/version.txt dla Scala do odczytu.

W Makefile:

$(RESOURCES_VERSION): build.sbt 
    grep "^version := " $< | cut -f2 -d\" > $@ 

W Scala:

val version: String = { 
    val src = Source.fromURL(getClass.getResource("/version.txt")) 
    src.getLines.next // just take the first line 
} 

Działa to dla mnie.

Ciekawe, że taka potrzebna funkcja (jak sądzę) nie jest łatwo dostępna w Scali. Bardzo prosta wtyczka sbt tylko byłaby mile widziana.

Answer 4

Generalnie bez żadnych wtyczek, można zrobić coś takiego:

sourceGenerators in Compile += Def.task { 
    val file = (sourceManaged in Compile).value/"foo"/"bar"/"BuildInfo.scala" 

    IO.write(
    file, 
    s"""package foo.bar 
     |object BuildInfo { 
     | val Version = "${version.value}" 
     |}""".stripMargin 
) 

    Seq(file) 
}.taskValue 

A potem zrobić z foo.bar.BuildInfo.Version stałej cokolwiek chcesz.

lub bardziej ogólnie:

def generateBuildInfo(packageName: String, 
         objectName: String = "BuildInfo"): Setting[_] = 
    sourceGenerators in Compile += Def.task { 
    val file = 
     packageName 
     .split('.') 
     .foldLeft((sourceManaged in Compile).value)(_/_)/s"$objectName.scala" 

    IO.write(
     file, 
     s"""package $packageName 
     |object $objectName { 
     | val Version = "${version.value}" 
     |}""".stripMargin 
    ) 

    Seq(file) 
    }.taskValue 

przykład:

settings(generateBuildInfo("foo.bar")) 

Można również zmienić przejść właściwości obiektu jako Map[String, String] i generowania obiektu odpowiednio.