Maven Graph Plugin - graph:report

Required Parameters

Name	Type	Since	Description
direction	`Direction`	`-`	The direction for the graph layout. Valid values are TB, LR, BT, RL. Top to bottom, left to right, bottom to top, and right to left, respectively. Default value is: `TB`.
imagesPath	`String`	`-`	Path relative to the output folder where images are created. Default value is: `images/dependencies`.
outputDir	`File`	`-`	The directory graphs are generated into. Default value is: `${project.build.directory}/graph`.
reportOutputDirectory	`File`	`-`	Output folder where the main page of the report will be generated. Note that this parameter is only relevant if the goal is run directly from the command line or from the default lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin will be used instead.
type	`String`	`-`	The type of image files to produce Default value is: `png`.
useDefaultDescriptors	`boolean`	`-`	If true, the default set of graphs is generated in addition to those provided in the `descriptors` list. Default value is: `true`.

Optional Parameters

Name	Type	Since	Description
cascadeOptional	`boolean`	`-`	If true, any dependency marked as optional will have all of its transitive dependencies displayed as optional also. Default value is: `true`.
descriptors	`List`	`-`	List of graph descriptors.
executeDot	`boolean`	`-`	Set this to false to skip executing the "dot" binary that produces an image from the .dot text file Default value is: `true`.
ignoreDotFailure	`boolean`	`-`	Set this to true to prevent the overall Maven build from failing if the "dot" binary returns a non-zero exit value. Default value is: `false`.
keepDotFile	`boolean`	`-`	Set to true to retain the .dot text file Graphviz uses to draw the graph Default value is: `false`.
showConflicts	`boolean`	`-`	If true, dependency conflicts are displayed on the graph Default value is: `true`.
showDuplicates	`boolean`	`-`	If true, duplicate dependencies are displayed on the graph. Default value is: `false`.
showGroupIds	`boolean`	`-`	If true, artifact group id's are displayed on the graph. Default value is: `true`.
showLegend	`boolean`	`-`	If true, any criteria used to filter the dependency tree are shown as a legend. Default value is: `true`.
showTitle	`boolean`	`-`	If true, the title for the graph will be displayed. Default value is: `true`.
skip	`boolean`	`-`	If true, mojo execution is skipped. Default value is: `false`.
title	`String`	`-`	The title for the graph Default value is: `Dependency Graph for ${project.name}`.
verbose	`boolean`	`-`	If true, metadata about the dependency tree is displayed. Default value is: `false`.

Parameter Details

cascadeOptional:

If true, any dependency marked as optional will have all of its transitive dependencies displayed as optional also.

Type: boolean
Required: No
Expression: ${graph.cascadeOptional}
Default: true

descriptors:

List of graph descriptors.

Type: java.util.List
Required: No

direction:

The direction for the graph layout. Valid values are TB, LR, BT, RL. Top to bottom, left to right, bottom to top, and right to left, respectively.

Type: org.kuali.maven.plugins.graph.pojo.Direction
Required: Yes
Expression: ${graph.direction}
Default: TB

executeDot:

Set this to false to skip executing the "dot" binary that produces an image from the .dot text file

Type: boolean
Required: No
Expression: ${graph.executeDot}
Default: true

ignoreDotFailure:

Set this to true to prevent the overall Maven build from failing if the "dot" binary returns a non-zero exit value.

Type: boolean
Required: No
Expression: ${graph.ignoreDotFailure}
Default: false

imagesPath:

Path relative to the output folder where images are created.

Type: java.lang.String
Required: Yes
Expression: ${graph.imagesPath}
Default: images/dependencies

keepDotFile:

Set to true to retain the .dot text file Graphviz uses to draw the graph

Type: boolean
Required: No
Expression: ${graph.keepDotFile}
Default: false

outputDir:

The directory graphs are generated into.

Type: java.io.File
Required: Yes
Expression: ${graph.dir}
Default: ${project.build.directory}/graph

reportOutputDirectory:

Output folder where the main page of the report will be generated. Note that this parameter is only relevant if the goal is run directly from the command line or from the default lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin will be used instead.

Type: java.io.File
Required: Yes
Expression: ${project.reporting.outputDirectory}

showConflicts:

If true, dependency conflicts are displayed on the graph