Built by Maven

changes:changes-validate

Full name:

org.apache.maven.plugins:maven-changes-plugin:3.0.0-M1: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: basedir

Optional Parameters

Name Type Since Description
<changesXsdVersion> String - The changes xsd version.
Default: 2.0.0
User Property: changes.xsdVersion
<failOnError> boolean - Mojo failure if validation failed. If not and validation failed, only a warning will be logged.
Default: false
User Property: 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: false
User Property: changes.runOnlyAtExecutionRoot
<xmlPath> File - The path of the changes.xml file that will be converted into an HTML report.
Default: src/changes/changes.xml
User Property: 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
  • Required: No
  • User Property: changes.xsdVersion
  • Default: 2.0.0

<failOnError>

Mojo failure if validation failed. If not and validation failed, only a warning will be logged.
  • Type: boolean
  • 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
  • Required: No
  • User Property: changes.xmlPath
  • Default: src/changes/changes.xml