Plugin Documentation

Goals available for this plugin:

Goal Description
play:clean Clean Play! temporary directories. Directories being cleaned (fully configurable): - "db" - "lib" and "modules" - "logs" - "precompiled" - "test-result" - "tmp"
play:dependencies Extract project dependencies to "lib" and "modules" directories. It's like Play! framework's "dependencies" command, but uses Maven dependencies, instead of "conf/dependencies.yml" file.
play:dist Package Play! framework and Play! application as one zip achive (standalone distribution).
play:dist-exploded Create exploded Play! framework and Play! application (standalone distribution).
play:generate-selenium-junit4-sources Generate JUnit test wrapper source files for Selenium tests. Maven Surefire plugin operates on Java test classes (JUnit or TestNG). Play! application Selenium tests are defined in "*.test.html" files so there is a need for a JUnit (or TestNG) wrapper for every Selenium test.
play:help Display help information on play-maven-plugin.
Call mvn play:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
play:initialize Initialize Play! Maven project. - Checks Play! home directory and creates temporary Play! home in "target" directory if no Play! home directory defined and there is Play! framework zip dependency in the project. - Adds application and dependent modules sources to Maven project as compile source roots. - Adds application resources to Maven project as resources. - Adds application test sources to Maven project as test compile source roots.
play:precompile Invoke Play! precompilation.
play:run Run Play! server ("play run" equivalent).
play:start Start Play! server ("play start" equivalent).
play:start-server Start Play! server before integration testing.
play:stop Stop Play! server ("play stop" equivalent).
play:stop-server Stop Play! server after integration testing.
play:test Run Play! server in test mode ("play test" equivalent).
play:war Package Play! application as a war achive.
play:war-exploded Create an exploded Play! application webapp in specified directory.
play:war-inplace Create an exploded Play! application webapp in war source directory.
play:war-support Prepare project for war packaging. For now only prepares "web.xml" file (replaces %APPLICATION_NAME% and %PLAY_ID% with actual values).
play:zip Package Play! application as a zip achive.

System Requirements

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

Maven 2.2.1
JDK 1.5
Memory No minimum requirement.
Disk Space No minimum requirement.

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>com.google.code.maven-play-plugin</groupId>
          <artifactId>play-maven-plugin</artifactId>
          <version>1.0.0-beta8</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>com.google.code.maven-play-plugin</groupId>
        <artifactId>play-maven-plugin</artifactId>
        <version>1.0.0-beta8</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

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