Examples

Minimal Setup

Enable build constants with the project version embedded:

kreate {
    project {
        name = "MyLibrary"
        projectGroup = group.toString()

        buildConstant {
            enabled.set(true)
            constant("version", project.version)
        }
    }
}

Generated output in com.example.mylibrary.build:

object BuildConstants {
    const val VERSION: String = "1.0.0"
}

Embedding Multiple Values

buildConstant {
    enabled.set(true)
    constant("version", project.version)
    constant("name", project.name)
    constant("group", project.group)
    constant("buildTime", System.currentTimeMillis())
    constant("debug", "false")
}

Custom Class Name and Package

Override the defaults for full control over the generated type:

buildConstant {
    enabled.set(true)
    className.set("AppInfo")
    packageNameOverride.set("com.davils.app.meta")
    constant("version", project.version)
}

Generated file at build/generated/compile/com/davils/app/meta/build/AppInfo.kt:

object AppInfo {
    const val VERSION: String = "2.3.1"
}

Custom Output Path

Place the generated sources in a non-default directory inside build/:

buildConstant {
    enabled.set(true)
    path.set("generated/kreate")
    constant("version", project.version)
}

The source set is still wired automatically — no manual srcDir call is needed.

Using Constants in Code

After the kreate-build-constants task runs (automatically before compilation), import the generated object:

import com.example.mylibrary.build.BuildConstants

fun printBuildInfo() {
    println("Version : ${BuildConstants.VERSION}")
    println("Name    : ${BuildConstants.NAME}")
}

For Kotlin Multiplatform, the class is available in commonMain and all its dependant source sets (jvmMain, nativeMain, etc.) without additional setup.

26 April 2026