BuildMark Gradle Plugin

A Gradle plugin that generates a Kotlin object with build information at compile time. This allows you to access build-time properties in your application at runtime.

Installation

Add the plugin to your build script:

plugins {
    id("io.github.tomhula.buildmark") version "<VERSION>"
}

buildMark {
    // Package for the generated object (default: root package)
    targetPackage.set("com.example.app")
    // Name of the generated object (default: "BuildMark")
    targetObjectName.set("AppBuildInfo")
    // The properties to include in the generated object
    options.apply {
        put("VERSION", project.version)
        put("PROJECT_NAME", project.name)
        put("AUTHORS", listOf("author1", "author2"))
        put("BUILD_TIME", System.currentTimeMillis())
        put("GIT_COMMIT", "abc123") // You could use a Git plugin to get the actual commit
        put("DEBUG", true)
    }

    // Specify which Kotlin source sets should include the generated code
    // By default, it's added to the first source set
    kotlinSourceSets.set(listOf(kotlin.sourceSets.getByName("main")))
}

Once applied and configured, you can access the defined options in your code. (in the configured source-sets)

// This package was configured, default is the root package (no package)
import com.example.app.AppBuildInfo

fun main()
{
    // AppBuildInfo name was configured, default is BuildMark
    println("Starting version ${AppBuildInfo.VERSION} of ${AppBuildInfo.PROJECT_NAME}")

    println("Authors:")
    AppBuildInfo.AUTHORS.forEach {
        println(it)
    } 
    
    if (AppBuildInfo.DEBUG)
        logger.setLevel(Level.DEBUG)
}

Advantages over alternatives

An alternative way to pass information to the runtime using Gradle is with command line arguments. However, this only works when running from Gradle.

Another advantage is Kotlin multiplatform projects. If you apply this plugin on the shared module in the common source-set, you get access to the same information all modules, which might, for example, be a JVM backend and a JavaScript frontend.

Contributing

Contributions are welcome! Feel free to submit issues or Pull Requests.

License

MIT © Tomáš Hůla