sbt/sbt-buildinfo — an open-source project — sits at 556 GitHub stars. I know this because build.sbt knows this.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
lazy val root = (project in file(".")).
enablePlugins(BuildInfoPlugin).
settings(
buildInfoKeys := Seq[BuildInfoKey](name, version, scalaVersion, sbtVersion),
buildInfoPackage := "hello"
)
When you reload the settings and compile, this generates the following:
package hello
/** 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)
}
As this is generated source it will be found under target, specifically for a Scala 2.11 project under target/scala-2.11/src_managed/main/sbt-buildinfo
Customize buildInfoKeys by adding whatever keys you want to have in BuildInfo. You can use BuildInfoKey.map to change the generated field name and value, add new fields with tuples, or add new fields with values computed at build-time. Note: BuildInfoKey.map can handle both SettingKey[T] and TaskKey[T] types as arguments:
buildInfoKeys ++= Seq[BuildInfoKey](
resolvers,
Test / libraryDependencies,
BuildInfoKey.map(name) { case (k, v) => "project" + k.capitalize -> v.capitalize },
"custom" -> 1234, // computed at project load time
BuildInfoKey.action("buildTime") {
System.currentTimeMillis
} // re-computed each time at compile
)
This generates:
/** The value is Seq("Sonatype Public: https://oss.sonatype.org/content/groups/public"). */
val resolvers: Seq[String] = Seq("Sonatype Public: https://oss.sonatype.org/content/groups/public")
/** The value is Seq("org.scala-lang:scala-library:2.9.1", ...). */
val test_libraryDependencies: Seq[String] = Seq("org.scala-lang:scala-library:2.9.1", ...)
/** The value is "Helloworld". */
val projectName = "Helloworld"
/** The value is 1234. */
val custom = 1234
/** The value is 1346906092160L. */
val buildTime = 1346906092160L
Tasks can be added only if they do not depend on sourceGenerators. Otherwise, it will cause an infinite loop.
Here's how to change the generated object name:
buildInfoObject := "Info"
This changes the generated object name to object Info. Changing the object name is optional, but to avoid name clash with other jars, package name should be unique. Use buildInfoPackage key for this.
buildInfoPackage := "hello"
build number
A build number can be generated as follows. Note that cross building against multiple Scala would each generate a new number.
/** The value is "2015-07-30 03:30:16.849-0700". */
val builtAtString: String = "2015-07-30 03:30:16.849-0700"
/** The value is 1438227016849L. */
val builtAtMillis: Long = 1438227016849L
BuildInfoOption.PackagePrivate
Set the package using buildInfoPackage and use the option BuildInfoOption.PackagePrivate
to explicitly import scala.Predef._ in the generated code.
package hello
import scala.Predef._
/** This object was generated by sbt-buildinfo. */
case object BuildInfo {
...
}
This import is necessary only when using compiler option -Yno-imports. Please note, the generated import is not compatible when compiling with Scala 3 compiler option -source:future because import wildcards must be *.
No homepage URL was recorded for sbt/sbt-buildinfo in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
Is sbt/sbt-buildinfo open source?
Yes — sbt/sbt-buildinfo ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/sbt/sbt-buildinfo.
What is sbt/sbt-buildinfo?
sbt/sbt-buildinfo (sbt/sbt-buildinfo) is a Scala project on GitHub. From the project's own README: I know this because build.sbt knows this.
What license does sbt/sbt-buildinfo use?
sbt/sbt-buildinfo is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
Where do I read more about sbt/sbt-buildinfo?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/sbt/sbt-buildinfo is the definitive source.
Read full README in the tab above.
Is sbt-buildinfo worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of sbt-buildinfo.
/sbt-buildinfo