Skip to content
This repository was archived by the owner on Aug 2, 2022. It is now read-only.

Configuration

Jump to bottom
Invvk edited this page Sep 9, 2021 · 4 revisions

Configuration

  • fileName: This defines the name for the .properties file generated by the plugin. this is where data like major, minor, and patch is saved.

VERSIONS: 1.1.X
DEFAULT: data
REQUIRED: NO

[x] NOTE: in versions 1.0.1, 1.0.0 it is known as storageName

  • gitDirectory: This is going to be the path for .git directory to obtain informations like commit hash, commit time, and branch name

VERSIONS: 1.1.X, 1.0.X
DEFAULT: PROJECT_FILE/.git/
REQUIRED: NO

[x] Note: Attention! this is required in versions that is lower than 1.1.0

  • commitLength: This defines the length of the commit hash.

VERSIONS: 1.1.X
DEFAULT: 7
REQUIRED: NO

In versions 1.0.1,1.0.0:

  • hashMode: defines the length of the commit hash, it has two options either SHORT or LONG
    • in 1.0.1 the default is SHORT
    • in 1.0.0 the default is LONG

    REQUIRED: NO

  • commit: Should the plugin include current commit hash in aip.version.full ?

VERSIONS: 1.1.X
DEFAULT: false
REQUIRED: NO

In versions 1.0.1,1.0.0:

  • includeHash: Should the plugin include current commit hash in
    • aip.version.full in 1.0.1 ?
    • autoincrement.version in 1.0.0 ?

    REQUIRED: NO DEFAULT: false

  • patch: Should the plugin include current build patch in aip.version.full ?

VERSIONS: 1.1.X
DEFAULT: false
REQUIRED: NO

In versions 1.0.1,1.0.0:

  • includePatch: Should the plugin include current build patch in
    • aip.version.full in version 1.0.1
    • autoincrement.version in version 1.0.0

    REQUIRED: NO DEFAULT: false

  • patchLimit: after each build, the patch count increases. if the current patch count is bigger than patchLimit, it will reset back to 0 and increases minor count.

VERSIONS: 1.1.X, 1.0.X
DEFAULT: 9
REQUIRED: NO

  • minorLimit: after each build, the minor count increases. if the current minor count is bigger than minorLimit, it will reset back to 0 and increases major count.

VERSIONS: 1.1.X, 1.0.X
DEFAULT: 9
REQUIRED: NO

  • pump: should the plugin update the .properties file with the next version ?

VERSIONS: 1.1.X
DEFAULT: true
REQUIRED: NO

[x] NOTE: it is known as skipUpdating in 1.0.1,1.0.0

  • disableGit: disable all operations that is related to git. properties that starts with aip.git will stop working.

VERSIONS: 1.1.X
DEFAULT: false
REQUIRED: NO

[x] NOTE: in older versions this is not possible.

Clone this wiki locally