clirr:check-arbitrary

Full name:

org.codehaus.mojo:clirr-maven-plugin:2.4:check-arbitrary

Description:

Check for compatibility between two arbitrary artifact sets.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Binds by default to the lifecycle phase: verify.
  • Invokes the execution of the lifecycle phase compile prior to executing itself.

Required Parameters

Name Type Since Description
newComparisonArtifacts ArtifactSpecification[] - List of artifacts to compare to baseline.
oldComparisonArtifacts ArtifactSpecification[] - List of artifacts to serve as a baseline to compare against.

Optional Parameters

Name Type Since Description
classesDirectory File - The classes of this project to compare the last release against.
Default value is: ${project.build.outputDirectory}.
comparisonArtifacts ArtifactSpecification[] - List of artifacts to compare the current code against. This overrides comparisonVersion, if present. Each comparisonArtifact is made of a groupId, an artifactId and a version number. Optionally it may have a classifier (default null) and a type (default "jar").
comparisonVersion String - Version to compare the current code against.
Default value is: (,${project.version}).
excludes String[] - A list of classes to exclude. These classes are excluded from the list of classes that are included. Values are specified in path pattern notation, e.g. org/codehaus/mojo/**.
failOnError boolean - Whether to fail on errors.
Default value is: true.
failOnWarning boolean - Whether to fail on warnings.
Default value is: false.
includes String[] - A list of classes to include. Anything not included is excluded. If omitted, all are assumed to be included. Values are specified in path pattern notation, e.g. org/codehaus/mojo/**.
logResults boolean - Whether to log the results to the console or not.
Default value is: false.
minSeverity String - Show only messages of this severity or higher. Valid values are info, warning and error.
Default value is: warning.
skip boolean - Flag to easily skip execution.
Default value is: false.
textOutputFile File - A text output file to render to. If omitted, no output is rendered to a text file.
xmlOutputFile File - An XML file to render to. If omitted, no output is rendered to an XML file.

Parameter Details

classesDirectory:

The classes of this project to compare the last release against.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.outputDirectory}

comparisonArtifacts:

List of artifacts to compare the current code against. This overrides comparisonVersion, if present. Each comparisonArtifact is made of a groupId, an artifactId and a version number. Optionally it may have a classifier (default null) and a type (default "jar").
  • Type: org.codehaus.mojo.clirr.ArtifactSpecification[]
  • Required: No

comparisonVersion:

Version to compare the current code against.
  • Type: java.lang.String
  • Required: No
  • Expression: ${comparisonVersion}
  • Default: (,${project.version})

excludes:

A list of classes to exclude. These classes are excluded from the list of classes that are included. Values are specified in path pattern notation, e.g. org/codehaus/mojo/**.
  • Type: java.lang.String[]
  • Required: No

failOnError:

Whether to fail on errors.
  • Type: boolean
  • Required: No
  • Expression: ${failOnError}
  • Default: true

failOnWarning:

Whether to fail on warnings.
  • Type: boolean
  • Required: No
  • Expression: ${failOnWarning}
  • Default: false

includes:

A list of classes to include. Anything not included is excluded. If omitted, all are assumed to be included. Values are specified in path pattern notation, e.g. org/codehaus/mojo/**.
  • Type: java.lang.String[]
  • Required: No

logResults:

Whether to log the results to the console or not.
  • Type: boolean
  • Required: No
  • Expression: ${logResults}
  • Default: false

minSeverity:

Show only messages of this severity or higher. Valid values are info, warning and error.
  • Type: java.lang.String
  • Required: No
  • Expression: ${minSeverity}
  • Default: warning

newComparisonArtifacts:

List of artifacts to compare to baseline.
  • Type: org.codehaus.mojo.clirr.ArtifactSpecification[]
  • Required: Yes

oldComparisonArtifacts:

List of artifacts to serve as a baseline to compare against.
  • Type: org.codehaus.mojo.clirr.ArtifactSpecification[]
  • Required: Yes

skip:

Flag to easily skip execution.
  • Type: boolean
  • Required: No
  • Expression: ${clirr.skip}
  • Default: false

textOutputFile:

A text output file to render to. If omitted, no output is rendered to a text file.
  • Type: java.io.File
  • Required: No
  • Expression: ${textOutputFile}

xmlOutputFile:

An XML file to render to. If omitted, no output is rendered to an XML file.
  • Type: java.io.File
  • Required: No
  • Expression: ${xmlOutputFile}