jgitver: project versioning like a geek git

sh -c "$(curl -fsSL https://git.io/fA6sj)"

sh -c "$(wget -q https://git.io/fA6sj -O -)"

<extensions xmlns="http://maven.apache.org/EXTENSIONS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/EXTENSIONS/1.0.0 http://maven.apache.org/xsd/core-extensions-1.0.0.xsd">
  <extension>
    <groupId>fr.brouillard.oss</groupId>
    <artifactId>jgitver-maven-plugin</artifactId>
    <version>1.5.1</version>
  </extension>
</extensions>

$ mvn validate
[INFO] no suitable configuration file found, using defaults
[INFO] Scanning for projects...
[INFO] Using jgitver-maven-plugin [1.3.0] (sha1: ef8eec9f820d662e63a84f1210c377183e450cbd)
[INFO] jgitver-maven-plugin is about to change project(s) version(s)
[INFO]     fr.brouillard.oss::jgitver::0 -> 0.7.0-SNAPSHOT

<configuration xmlns="http://jgitver.github.io/maven/configuration/1.1.0"
	    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	    xsi:schemaLocation="http://jgitver.github.io/maven/configuration/1.1.0 https://jgitver.github.io/maven/configuration/jgitver-configuration-v1_1_0.xsd">

    <!-- One of MAVEN, CONFIGURABLE, PATTERN -->
    <strategy>MAVEN</strategy>

    <!-- Deprecated (this field replaced and overridden by strategy), boolean -->
    <mavenLike>true</mavenLike>

    <!-- One of MAX, LATEST, NEAREST -->
    <policy>MAX</policy>

    <!-- Boolean -->
    <autoIncrementPatch>true</autoIncrementPatch>

    <!-- Boolean -->
    <useCommitDistance>true</useCommitDistance>

    <!-- Boolean -->
    <useDirty>false</useDirty>

    <!-- Boolean -->
    <useGitCommitId>false</useGitCommitId>

    <!-- Integer between 8 and 40 inclusive -->
    <gitCommitIdLength>8</gitCommitIdLength>

    <!-- Integer -->
    <maxSearchDepth>Integer.MAX_VALUE</maxSearchDepth>

    <!-- String, comma separate multiple branches -->
    <nonQualifierBranches>master</nonQualifierBranches>

    <!-- An optional list of directories to not assign Jgitver's version for -->
    <exclusions>
        <!-- String, relative path from project root -->
        <exclusion></exclusion>
    </exclusions>

    <!-- Boolean -->
    <useDefaultBranchingPolicy>true</useDefaultBranchingPolicy>

    <!-- String, only for PATTERN strategy" -->
    <versionPattern>${v}${&lt;meta.QUALIFIED_BRANCH_NAME}${&lt;meta.COMMIT_DISTANCE}</versionPattern>
    <!-- Usages of "<" are escaped with "&lt;" -->

    <!-- String, only for PATTERN strategy -->
    <tagVersionPattern>${v}</tagVersionPattern>

    <branchPolicies>
        <branchPolicy>
            <!-- String, regex with one capture group -->
            <pattern></pattern>
            <transformations>
                <!-- String, a name of a transformation -->
                <transformation>REPLACE_UNEXPECTED_CHARS_UNDERSCORE</transformation>
                <transformation>LOWERCASE_EN</transformation>
            </transformations>
        </branchPolicy>
    </branchPolicies>

    <!-- String, regex with at least one capture group -->
    <regexVersionTag>v?([0-9]+(?:\\.[0-9]+){0,2}(?:-[a-zA-Z0-9\\-_]+)?)</regexVersionTag>
</configuration>

<configuration xmlns="http://jgitver.github.io/maven/configuration/1.1.0"
	    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	    xsi:schemaLocation="http://jgitver.github.io/maven/configuration/1.1.0 https://jgitver.github.io/maven/configuration/jgitver-configuration-v1_1_0.xsd">
    <branchPolicies>
        <branchPolicy>
            <pattern>feature_(.*)</pattern>
            <transformations>
                <transformation>REMOVE_UNEXPECTED_CHARS</transformation>
                <transformation>UPPERCASE</transformation>
            </transformations>
        </branchPolicy>
        <branchPolicy>
            <pattern>(master)</pattern>
            <transformations>
                <transformation>IGNORE</transformation>
            </transformations>
        </branchPolicy>
    </branchPolicies>
</configuration>

jgitver {
    // One of 'MAVEN', 'CONFIGURABLE', 'PATTERN'
    strategy 'CONFIGURABLE'

    // Deprecated (use strategy instead), boolean
    mavenLike false

    // One of 'MAX', 'LATEST', 'NEAREST'
    policy 'MAX'

    // Boolean
    autoIncrementPatch true

    // Boolean
    useDistance true

    // Boolean
    useDirty false

    // Boolean
    failIfDirty false

    // Boolean
    useGitCommitTimestamp false

    // Boolean
    useGitCommitID false

    // Integer between 8 and 40 inclusive
    gitCommitIDLength 8

    // Since plugin version 0.7.0, integer
    maxDepth Integer.MAX_VALUE

    // String, comma separate multiple branches
    nonQualifierBranches 'master'

    // Since plugin version 0.6.0, string, only for PATTERN strategy
    versionPattern '${v}${<meta.QUALIFIED_BRANCH_NAME}${<meta.COMMIT_DISTANCE}'

    // Since plugin version 0.6.0, string, only for PATTERN strategy
    tagVersionPattern '${v}'

    // Closure, can be set multiple times
    policy {
        // String, regex with one capture group
        pattern =
        // Array of strings, each being a transformation
        transformations = ['REPLACE_UNEXPECTED_CHARS_UNDERSCORE', 'LOWERCASE_EN']
    }

    // One of 'FIRST_PARENT', 'LOG', 'DEPTH'
    distanceCalculatorKind 'FIRST_PARENT'

    // String, regex with at least one capture group
    regexVersionTag 'v?([0-9]+(?:\\.[0-9]+){0,2}(?:-[a-zA-Z0-9\\-_]+)?)'
}

jgitver {
    policy {
		pattern = 'feature_(.*)'
		transformations = ['REMOVE_UNEXPECTED_CHARS', 'UPPERCASE']
	}
    policy {
		pattern = '(master)'
		transformations = ['IGNORE']
	}
}

// Define plugin here (only actually applies the plugin in the root project)
plugins {
    id "fr.brouillard.oss.gradle.jgitver" version "0.9.1"
}

allprojects {

    // Ensure plugin is applied in all projects
    apply plugin: 'fr.brouillard.oss.gradle.jgitver'

    jgitver {
        // Your config goes here
    }
}