gradle-josm-plugin / org.openstreetmap.josm.gradle.plugin / GitDescriber

GitDescriber

class GitDescriber : Describer

Uses jGit to describe the current HEAD of a git repository

Parameters

workTree - the directory where the work tree of the git repository is (typically the parent directory of the .git directory)

Constructors

<init>

GitDescriber(workTree: File)

Uses jGit to describe the current HEAD of a git repository

Properties

workTree

val workTree: File

the directory where the work tree of the git repository is (typically the parent directory of the .git directory)

Functions

commitHash

fun commitHash(): String

describe

fun describe(dirty: Boolean, trimLeading: Boolean): String

Replicates the git describe command. Never null, either returns a String or throws an exception