Fork me on GitHub

mavanagaiata:contributors

Full name:

com.github.koraktor:mavanagaiata:1.0.1:contributors

Description:

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.

Attributes:

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

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.
<contributorPrefix> String - The string to prepend to every contributor name
Default value is: * .
User property is: mavanagaiata.contributors.contributorPrefix.
<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.
<encoding> String - The encoding to use for generated output
Default value is: UTF-8.
User property is: mavanagaiata.encoding.
<escapeHtml> boolean - (no description)
Default value is: false.
User property is: mavanagaiata.contributors.escapeHtml.
<escapeMarkdown> boolean - (no description)
Default value is: false.
User property is: mavanagaiata.contributors.escapeMarkdown.
<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.
<footer> String - The footer to print below the output
Default value is: Generated by Mavanagaiata %s at %s.
User property is: mavanagaiata.footer.
<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.
<header> String - The header to print above the changelog
Default value is: Contributors ============ .
User property is: mavanagaiata.contributors.header.
<outputFile> File - The file to write the contributors list to
User property is: mavanagaiata.contributors.outputFile.
<propertyPrefixes> String[] - The prefixes to prepend to property keys
Default value is: mavanagaiata,mvngit.
User property is: mavanagaiata.propertyPrefixes.
<showCounts> boolean - Whether the number of contributions should be listed
Default value is: true.
User property is: mavanagaiata.contributors.showCounts.
<showEmail> boolean - Whether the email addresses of contributors should be listed
Default value is: false.
User property is: mavanagaiata.contributors.showEmail.
<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.
<sort> String - The method used to sort contributors

Available values are count, date and name.


Default value is: count.
User property is: mavanagaiata.contributors.sort.

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}

<contributorPrefix>

The string to prepend to every contributor name
  • Type: java.lang.String
  • Required: No
  • User Property: mavanagaiata.contributors.contributorPrefix
  • Default: *

<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

<encoding>

The encoding to use for generated output
  • Type: java.lang.String
  • Required: No
  • User Property: mavanagaiata.encoding
  • Default: UTF-8

<escapeHtml>

(no description)
  • Type: boolean
  • Required: No
  • User Property: mavanagaiata.contributors.escapeHtml
  • Default: false

<escapeMarkdown>

(no description)
  • Type: boolean
  • Required: No
  • User Property: mavanagaiata.contributors.escapeMarkdown
  • 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

<footer>

The footer to print below the output
  • Type: java.lang.String
  • Required: No
  • User Property: mavanagaiata.footer
  • Default: Generated by Mavanagaiata %s at %s

<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

<header>

The header to print above the changelog
  • Type: java.lang.String
  • Required: No
  • User Property: mavanagaiata.contributors.header
  • Default: Contributors ============

<outputFile>

The file to write the contributors list to
  • Type: java.io.File
  • Required: No
  • User Property: mavanagaiata.contributors.outputFile

<propertyPrefixes>

The prefixes to prepend to property keys
  • Type: java.lang.String[]
  • Required: No
  • User Property: mavanagaiata.propertyPrefixes
  • Default: mavanagaiata,mvngit

<showCounts>

Whether the number of contributions should be listed
  • Type: boolean
  • Required: No
  • User Property: mavanagaiata.contributors.showCounts
  • Default: true

<showEmail>

Whether the email addresses of contributors should be listed
  • Type: boolean
  • Required: No
  • User Property: mavanagaiata.contributors.showEmail
  • Default: false

<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

<sort>

The method used to sort contributors

Available values are count, date and name.

  • Type: java.lang.String
  • Required: No
  • User Property: mavanagaiata.contributors.sort
  • Default: count