SBT bao gồm số phiên bản trong chương trình

Question

Tôi muốn một chương trình tôi đang xây dựng có thể báo cáo phiên bản riêng của mình khi chạy (ví dụ: scala myprog.jar --version). Theo truyền thống trong một dự án maven, tôi sẽ sử dụng lọc tài nguyên (pom.xml -> file.properties -> đọc giá trị khi chạy). Tôi biết có sbt-filter-plugin để mô phỏng chức năng này, nhưng tôi tò mò nếu có một cách tiêu chuẩn/ưa thích/thông minh hơn để làm điều này trong SBT.

tl; dr làm cách nào để đọc số phiên bản được xác định trong build.sbt khi chạy?

Answer 1

Update ...

https://github.com/ritschwumm/xsbt-reflect (nêu trên) là lỗi thời, nhưng có SBT công cụ phát hành mát mẻ này có thể tự động quản lý phiên bản và nhiều hơn nữa: https://github.com/sbt/sbt-release.

Ngoài ra, nếu bạn muốn có một sửa chữa nhanh chóng bạn có thể nhận được phiên bản từ manifest như thế này:

val version: String = getClass.getPackage.getImplementationVersion 

Giá trị này sẽ bằng version thiết lập trong dự án của bạn mà bạn thiết lập hoặc trong build.sbt hoặc Build.scala.

Cập nhật Một ...

Buildinfo SBT plugin có thể tạo ra một lớp học với số phiên bản dựa trên 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) 
} 

Xem các tài liệu về cách kích hoạt nó ở đây: https://github.com/sbt/sbt-buildinfo/.

Answer 2

Sử dụng plugin xsbt-reflect. Nó sẽ tạo ra một tập tin nguồn có chứa, trong số những thứ khác, số phiên bản dự án.

Answer 3

Tôi đã kết thúc tạo hệ thống xây dựng (tôi sử dụng Makefile trên đầu trang sbt) chuẩn bị tệp src/main/resources/version.txt để Scala đọc.

Trong Makefile:

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

Trong Scala:

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

này làm việc cho tôi.

Thật lạ lùng rằng tính năng cần thiết như vậy (tôi nghĩ) không dễ dàng có trong Scala. Một plugin rất đơn giản sbt chỉ dành cho điều này sẽ được hoan nghênh.

Answer 4

Nói chung, mà không cần bất kỳ plugin, bạn có thể làm một cái gì đó như thế này:

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 

Và sau đó làm với foo.bar.BuildInfo.Version liên tục bất cứ điều gì bạn muốn.

Hoặc tổng quát hơn:

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 

Ví dụ:

settings(generateBuildInfo("foo.bar")) 

Bạn thậm chí có thể thay đổi điều này để vượt qua thuộc tính đối tượng như một Map[String, String] và tạo ra các đối tượng thích hợp.