Goals available for this plugin:
| Goal | Description |
|---|---|
| mavanagaiata:branch | This goal provides the currently checked out Git branch in the "mavanagaiata.branch" and "mvngit.branch" properties. |
| mavanagaiata:changelog | This goal allows to generate a changelog of the currently checked out branch of the Git repository. It will use information from tags and commit messages to build a reverse chronological summary of the development. It can be configured to display the changelog or save it to a file. |
| mavanagaiata:check | This goal checks various aspects of a Git repository to ensure it is in a valid state prior to a build
The following checks are available:
|
| mavanagaiata:commit | 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. |
| mavanagaiata:contributors | This goal allows to generate a list of contributors for the currently checked out branch of the Git repository. It will list all authors of the commits in this branch. It can be configured to display the changelog or save it to a file. |
| mavanagaiata:help | Display help information on mavanagaiata. Call mvn mavanagaiata:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. |
| mavanagaiata:info-class | This goal generates the source code for a Java class with Git information like commit ID and tag name. |
| mavanagaiata:tag | This goal provides the most recent Git tag in the "mavanagaiata.tag" and "mvngit.tag" properties. This goal provides the most recent Git tag name in the "mavanagaiata.tag.name" and "mvngit.tag.name" properties. Additionally, more exact information as per git describe is provided in the "mavanagaiata.tag.describe" and "mvngit.tag.describe" properties |
The following specifies the minimum requirements to run this Maven plugin:
| Maven | 3.3.9 |
| JDK | 1.8 |
You should specify the version in your project's plugin configuration:
<project>
...
<build>
<!-- To define the plugin version in your parent POM -->
<pluginManagement>
<plugins>
<plugin>
<groupId>com.github.koraktor</groupId>
<artifactId>mavanagaiata</artifactId>
<version>1.0.1</version>
</plugin>
...
</plugins>
</pluginManagement>
<!-- To use the plugin goals in your POM or parent POM -->
<plugins>
<plugin>
<groupId>com.github.koraktor</groupId>
<artifactId>mavanagaiata</artifactId>
</plugin>
...
</plugins>
</build>
...
</project>
For more information, see "Guide to Configuring Plug-ins"