Maven Tasks Plug-in

This plugin generates an HTML page of tasks from a tasks XML file.

Instructions

  1. Install the plugin per the general installation instructions.
  2. Add the tasks plugin to the report section in the project.xml file:
    <reports>
      ...
      <report>maven-tasks-plugin</report>
      ...
    </reports>
    
  3. Create a tasks.xml file in the project's xdocs directory (see layout in format section below).

    Note the output file name defaults to "tasks-report.html". Check the properties for how to customize it.

tasks.xml Format

Here's an example of a typical tasks.xml, showing the syntax:

<document
  xmlns="http://maven-plugins.sourceforge.net/tasks/1_0_0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven-plugins.sourceforge.net/tasks/1_0_0 http://maven-plugins.sourceforge.net/maven-tasks-plugin/xsd/tasks-1_0_0.xsd">

  <properties>
    <title>Tasks</title>
    <author email="andy@ajsoft.net">Andy Jefferson</author>
    <author email="jeffjensen@sourceforge.net">Jeff Jensen</author>
  </properties>

  <body>
    <category name="GUI" description="The GUI component" owner="Steve">
      <task creator="andy_jefferson" assignedto="fred" startdate="25/10/2003" enddate="25/11/2003" effort="30 hours" status="In Progress" version"1">
        Provide a Swing GUI.
      </task>
    </category>

    <category name="Maven" description="The GUI component" owner="Steve">
      <subcategory name="Builds">
        <task creator="jeffjensen" assignedto="mattpurland" startdate="25/8/2006" enddate="28/8/2006" effort="1 hour" status="In Progress" version"1">
          Setup build for new 2.1 codeline.
        </task>
      </subcategory>
      <subcategory name="FAQs">
        <task creator="jeffjensen" assignedto="jeffjensen" startdate="25/8/2006" enddate="28/8/2006" effort="1 hour" status="In Progress" version"1">
          Update Testing FAQ with dbUnit info.
        </task>
      </subcategory>
    </category>
  </body>
</document>

Notes

  • Category can have either task or subcategory elements.
  • Use the XML Schema for tasks.xml for verification. View the tasks schema here.