Skip to content

Latest commit

 

History

History
128 lines (99 loc) · 4.45 KB

README.md

File metadata and controls

128 lines (99 loc) · 4.45 KB
Raw

Mavanagaiata

Maven CI Test Coverage Maintainability Maven Release Liberapay

Mavanagaiata – [maˈvanaˈɡaːjaˈta] – is a Maven plugin providing information about the Git repository of your project.

Usage & Installation

Mavanagaiata is available from the Central Repository and will be automatically installed by Maven once you add it as a plugin to your project.

To use the Mavanagaiata plugin in your Maven project you will have to include the plugin in your POM and add the configuration suitable for your needs:

<project ...>
    ...
    <build>
        <plugins>
            <plugin>
                <groupId>com.github.koraktor</groupId>
                <artifactId>mavanagaiata</artifactId>
                <executions>
                    <execution>
                        <id>load-git-branch</id>
                        <goals>
                            <goal>branch</goal>
                            <goal>commit</goal>
                            <goal>tag</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            ...
        </plugins>
        ...
    </build>
</project>

For more information on the existing goals and their configuration can be found in the Plugin Documentation.

A more complete usage example can be found in Mavanagaiata’s own pom.xml. Yes, Mavanagaiata is used to build Mavanagaiata.

Requirements

  • Java 11 or newer
  • Maven 3.3.9 or newer

Dependencies

  • Apache Commons IO 2.11.0
  • Apache Commons Lang 3.12.0
  • Apache Commons Text 1.10.0
  • JGit 6.4.0
  • Maven Filtering 3.3.0

Contribute

Mavanagaiata is an open-source project. Therefore you are free to help improving it. There are several ways of contributing to Mavanagaiata’s development:

  • Build projects using it and spread the word.
  • Report problems and request features using the issue tracker.
  • Write patches yourself to fix bugs and implement new functionality.
  • Create a Mavanagaiata fork on GitHub and start hacking. Extra points for using GitHub’s pull requests and feature branches.

If you want to hack on the code you are free to clone the Git repository. You can do so using the following commands:

$ git clone git://github.com/koraktor/mavanagaiata.git
$ cd mavanagaiata
$ mvn install

About the name

The name is a completely invented word hopefully sounding like a mighty god of an ancient, Southeast Asian primitive people or a similar mighty monster that same primitive people is afraid of.

Instead, it’s just a combination of the command-line tools of Maven and Git: mvn and git. Each character is suffixed with the character a.

In Java code you would write this as:

("mvn" + "git").replaceAll("(.)", "$1a")
=> "mavanagaiata"

License

This code is free software; you can redistribute it and/or modify it under the terms of the new BSD License. A copy of this license can be found in the included LICENSE file.

Credits

  • Sebastian Staudt -- koraktor(at)gmail.com
  • Pablo Graña -- pablo.grana(at)globant.com
  • Henning Schmiedehausen -- hgschmie(at)fb.com
  • Santeri Vesalainen -- santeri.vesalainen(at)gmail.com
  • Patrick Kaeding -- pkaeding(at)atlassian.com
  • Kay Hannay -- klinux(at)hannay.de
  • Jeff Kreska -- jeff.kreska(at)farecompare.com

See Also