Mavanagaiata – mavanagaiata:commit

mavanagaiata:commit

Full name:

com.github.koraktor:mavanagaiata:1.0.1:commit

Description:

This goal provides the full ID of the current Git commit in the "mavanagaiata.commit.id", "mavanagaiata.commit.sha", "mvngit.commit.id", "mvngit.commit.sha" properties. The abbreviated commit ID is stored in the "mavanagaiata.commit.abbrev" and "mvngit.commit.abbrev" properties. Additionally the author's and committer's name and email address are stored in the properties "mavanagaiata.commit.author.name", "mavanagaiata.commit.author.email", "mvngit.commit.author.name" and "mvngit.commit.author.email", and "mavanagaiata.commit.committer.name", "mavanagaiata.commit.committer.email", "mvngit.commit.committer.name" and "mvngit.commit.committer.email" respectively.

Attributes:

Requires a Maven project to be executed.
The goal is thread-safe and supports parallel builds.
Since version: 0.1.0.
Binds by default to the lifecycle phase: initialize.

Optional Parameters

Name	Type	Since	Description
`<baseDir>`	`File`	`-`	The working tree of the Git repository. If there is only one project inside the Git repository this is probably `${project.basedir`} (default). Note: The `GIT_DIR` can be found automatically even if this is not the real working tree but one of its subdirectories. But Mavanagaiata cannot determine the state of the working tree (e.g. for the dirty flag) if this is not set correctly. Default value is: `${project.basedir}`. User property is: `mavanagaiata.baseDir`.
`<dateFormat>`	`String`	`-`	The date format to use for various dates Default value is: `MM/dd/yyyy hh:mm a Z`. User property is: `mavanagaiata.dateFormat`.
`<dirtyFlag>`	`String`	`0.4.0`	The flag to append to refs if there are changes in the index or working tree Setting this to either `"false"` or `"null"` will disable flagging refs as dirty. Default value is: `-dirty`. User property is: `mavanagaiata.dirtyFlag`.
`<dirtyIgnoreUntracked>`	`boolean`	`0.5.0`	Specifies if the dirty flag should also be appended if there are untracked files If `false` only modified files that are already known to Git will cause the dirty flag to be appended. Warning: Do not enable this if builds should be reproducible. Default value is: `false`. User property is: `mavanagaiata.dirtyIgnoreUntracked`.
`<failGracefully>`	`boolean`	`0.6.0`	Specifies if a failed execution of the mojo will stop the build process If `true` a failure during mojo execution will not stop the build process. Default value is: `false`. User property is: `mavanagaiata.failGracefully`.
`<gitDir>`	`File`	`-`	The `GIT_DIR` path of the Git repository Warning: Do not set this when you don't have a good reason to do so. The `GIT_DIR` can be found automatically if your project resides somewhere in a usual Git repository. User property is: `mavanagaiata.gitDir`.
`<head>`	`String`	`-`	The commit or ref to use as starting point for operations Default value is: `HEAD`. User property is: `mavanagaiata.head`.
`<propertyPrefixes>`	`String[]`	`-`	The prefixes to prepend to property keys Default value is: `mavanagaiata,mvngit`. User property is: `mavanagaiata.propertyPrefixes`.
`<skip>`	`boolean`	`0.5.0`	Skip the plugin execution Default value is: `false`. User property is: `mavanagaiata.skip`.
`<skipNoGit>`	`boolean`	`0.5.0`	Skip the plugin execution if not inside a Git repository Default value is: `false`. User property is: `mavanagaiata.skipNoGit`.

Parameter Details

<baseDir>

The working tree of the Git repository.

If there is only one project inside the Git repository this is probably ${project.basedir} (default).

Note: The GIT_DIR can be found automatically even if this is not the real working tree but one of its subdirectories. But Mavanagaiata cannot determine the state of the working tree (e.g. for the dirty flag) if this is not set correctly.

Type: java.io.File
Required: No
User Property: mavanagaiata.baseDir
Default: ${project.basedir}

<dateFormat>

The date format to use for various dates

Type: java.lang.String
Required: No
User Property: mavanagaiata.dateFormat
Default: MM/dd/yyyy hh:mm a Z

<dirtyFlag>

The flag to append to refs if there are changes in the index or working tree

Setting this to either "false" or "null" will disable flagging refs as dirty.

Type: java.lang.String
Since: 0.4.0
Required: No
User Property: mavanagaiata.dirtyFlag
Default: -dirty

<dirtyIgnoreUntracked>

Specifies if the dirty flag should also be appended if there are untracked files

If false only modified files that are already known to Git will cause the dirty flag to be appended.

Warning: Do not enable this if builds should be reproducible.

Type: boolean
Since: 0.5.0
Required: No
User Property: mavanagaiata.dirtyIgnoreUntracked
Default: false

<failGracefully>

Specifies if a failed execution of the mojo will stop the build process

If true a failure during mojo execution will not stop the build process.

Type: boolean
Since: 0.6.0
Required: No
User Property: mavanagaiata.failGracefully
Default: false

<gitDir>

The GIT_DIR path of the Git repository

Warning: Do not set this when you don't have a good reason to do so. The GIT_DIR can be found automatically if your project resides somewhere in a usual Git repository.

Type: java.io.File
Required: No
User Property: mavanagaiata.gitDir

<head>

The commit or ref to use as starting point for operations

Type: java.lang.String
Required: No
User Property: mavanagaiata.head
Default: HEAD

<propertyPrefixes>

The prefixes to prepend to property keys

Type: java.lang.String[]
Required: No
User Property: mavanagaiata.propertyPrefixes
Default: mavanagaiata,mvngit

<skip>

Skip the plugin execution

Type: boolean
Since: 0.5.0
Required: No
User Property: mavanagaiata.skip
Default: false

<skipNoGit>

Skip the plugin execution if not inside a Git repository

Type: boolean
Since: 0.5.0
Required: No
User Property: mavanagaiata.skipNoGit
Default: false