Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal Description
piranha:help Display help information on piranha-maven-plugin.
Call mvn piranha:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
piranha:run This goal will deploy your web application, start Piranha and wait for it. It echoes the Piranha console back to you for your convenience.
piranha:start This goal will deploy your web application and start Piranha in a separate process.
piranha:stop This goal will stop the Piranha runtime that was started with the start goal.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 4.0.0-beta-3
JDK 21

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version Maven JDK
from 24.6.0 to 24.9.0 - 21

Usage

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>cloud.piranha.maven</groupId>
          <artifactId>piranha-maven-plugin</artifactId>
          <version>24.10.99-SNAPSHOT</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>cloud.piranha.maven</groupId>
        <artifactId>piranha-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"