Gitonium

Gitonium is a Gradle plugin that derives the version number of the current project from the tags in its Git repository. Without configuration, Gitonium will find the last tag on the current branch that matches the pattern release-* and applies the derived version number to the current project and its subprojects.

Requirements

This plugin requires Gradle 7 or newer.

Apply

To apply this plugin, first add the Metaborg plugin repository to your settings.gradle file:

KotlinGroovy

settings.gradle.kts

pluginManagement {
    repositories {
        maven("https://artifacts.metaborg.org/content/repositories/releases/")
    }
}

settings.gradle

pluginManagement {
    repositories {
        maven {
            url "https://artifacts.metaborg.org/content/repositories/releases/"
        }
    }
}

Applying the plugin

Apply the gitonium plugin to a project (a build.gradle(.kts) file) as follows:

KotlinGroovy

build.gradle.kts

plugins {
    id("org.metaborg.gitonium") version "<version>"
}

version = gitonium.version

build.gradle

plugins {
    id "org.metaborg.gitonium" version "<version>"
}

version = gitonium.version

In a multi-project build, you can apply the plugin like this:

KotlinGroovy

build.gradle.kts

plugins {
    id("org.metaborg.gitonium") version "<version>"
}

allprojects {
    apply(plugin = "org.metaborg.gitonium")

    version = gitonium.version
}

build.gradle

plugins {
    id "org.metaborg.gitonium" version "<version>"
}

allprojects {
    apply plugin: "org.metaborg.gitonium"

    version = gitonium.version
}

Configuring the plugin

To configure the plugin, configure it before the version = assignment. For example:

KotlinGroovy

build.gradle.kts

plugins {
    id("org.metaborg.gitonium") version "<version>"
}

gitonium {
    mainBranch.set("master")
}

version = gitonium.version

build.gradle

plugins {
    id "org.metaborg.gitonium" version "<version>"
}

gitonium {
    mainBranch = "master"
}

version = gitonium.version