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

describe

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

Overrides Describer.describe

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

Parameters

dirty - if true, the string "-dirty" is appended when there are modified files in the work tree compared to the HEAD

trimLeading - iff true, the leading character v is removed from the version number (if present)

Return
a string that describes the current HEAD of the git repository