changes:changes-validate

Full name:

org.apache.maven.plugins:maven-changes-plugin:2.12:changes-validate

Description:

Goal which validate the changes.xml file.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.1.

Required Parameters

Name Type Since Description
basedir String 2.1 The current project base directory.
User property is: basedir.

Optional Parameters

Name Type Since Description
changesXsdVersion String 2.1 The changes xsd version.
Default value is: 1.0.0.
User property is: changes.xsdVersion.
failOnError boolean 2.1 Mojo failure if validation failed. If not and validation failed only a warning will be logged.
Default value is: false.
User property is: changes.validate.failed.
runOnlyAtExecutionRoot boolean 2.9 This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
Default value is: false.
User property is: changes.runOnlyAtExecutionRoot.
xmlPath File 2.1 The path of the changes.xml file that will be converted into an HTML report.
Default value is: src/changes/changes.xml.
User property is: changes.xmlPath.

Parameter Details

basedir:

The current project base directory.
  • Type: java.lang.String
  • Since: 2.1
  • Required: Yes
  • User Property: basedir

changesXsdVersion:

The changes xsd version.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • User Property: changes.xsdVersion
  • Default: 1.0.0

failOnError:

Mojo failure if validation failed. If not and validation failed only a warning will be logged.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • User Property: changes.validate.failed
  • Default: false

runOnlyAtExecutionRoot:

This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
  • Type: boolean
  • Since: 2.9
  • Required: No
  • User Property: changes.runOnlyAtExecutionRoot
  • Default: false

xmlPath:

The path of the changes.xml file that will be converted into an HTML report.
  • Type: java.io.File
  • Since: 2.1
  • Required: No
  • User Property: changes.xmlPath
  • Default: src/changes/changes.xml