Skip to content

Usage

Installation

Add the plugin to your plugins block in your module build.gradle.kts (or root build.gradle.kts):

plugins {
    id("io.github.kansalmohit19.git-version") version "X.Y.Z"
}

Plugin Configuration

Inside your Gradle module:

// Optional
gitVersion {
    // Optional: multiply git-based versionCode
    multiplier.set(1000)   // default = 1000

    // Optional: manually override versionName
    versionName.set("2.1.0")  
}

Usage in Android

android {
    defaultConfig {
        versionCode = gitVersion.code.get()
        versionName = gitVersion.name.get()
    }
}

Built-in Task

The plugin automatically provides a task:

./gradlew generateGitVersion
========== VERSION INFO ==========
Version Code: 65000
Version Name: 2.0.0
==================================

Creating Your Own Custom Task

You can register your own task and use gitVersion values:

tasks.register("printVersionInfo") {
    doLast {
        println("========== VERSION INFO ==========")
        println("Version Code: ${gitVersion.code.get()}")
        println("Version Name: ${gitVersion.name.get()}")
        println("==================================")
    }
}