Implementing Maven plugins has never been Groovier!
Groovy Maven plugins are very similar to Java Maven plugins. Actually a Groovy Maven plugin is compiled into Java byte-code, and once built, Maven can not tell the difference between a plugin which has been implemented in Java or Groovy.
For the most part, the existing guide for Developing Maven plugins with Java will also apply to developing plugins with Groovy. There are some differences though, which are covered here which can make Maven plugin development with Groovy better, faster, stronger
Be sure to read over the documentation for Building Groovy Projects. A Groovy Maven plugin is a Groovy project, so most of the information there is relevant here as well.
Putting More Groove into your Mojo
ant allows your Mojo access to any Ant tasks. Groovy Mojo's which extend from
GroovyMojoSupport have access to an
AntBuilder instance bound to the
This field is lazily initialized when you first reference it.
Below are some small examples of using
ant to perform common tasks, but really the sky is the limit on what you can do. See the Ant User Manual for more tasks you can execute
The following examples assume that your Mojo implementation has already defined a project field as in:
Touching a File
Most mojos need to report back some failure status, which is normally done by throwing a
MojoExecutionException. Groovy Mojos can simply invoke the fail() method, which handles the details of throwing for you.
Failing with a simple string:
Failing with an exception detail:
Failing with an exception detail and a message:
To help get Groovy plugins started faster, you can use the
gmaven-archetype-mojo. This will create a new project with the basic POM configuration and an example Groovy-based Mojo class to get you started quickly:
To use a specific version of an archetype specify
The Maven Archetype Plugin will ask a few questions about your new project:
Please ignore any
The above example would have created the following project structure: