changes:changes-check

Full name:

org.apache.maven.plugins:maven-changes-plugin:2.12.8:changes-check

Description:

Goal which checks that the changes.xml file has the necessary data to generate an announcement or a report for the current release.

Attributes:

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

Required Parameters

Name Type Since Description
<basedir> String 2.1 The current project base directory.
User property is: basedir.
<version> String 2.4 Version of the artifact.
Default value is: ${project.version}.
User property is: changes.version.

Optional Parameters

Name Type Since Description
<failOnError> boolean 2.4 Mojo failure in case of exception when getting no release for supplied arguments. If false only a warning will be logged.
Default value is: true.
User property is: changes.check.failOnError.
<releaseDateFormat> String 2.4 The format that a correct release date should have. This value will be used as a pattern to try to parse a date.
Default value is: yyyy-MM-dd.
User property is: changes.releaseDateFormat.
<releaseDateLocale> String 2.10 The locale that a correct release date should have. This value will be used as a locale to try to parse a date.
User property is: changes.releaseDateLocale.
<removeSnapshotSuffix> boolean 2.12.3 If "-SNAPSHOT" suffix should be removed when searching for issues.
Default value is: true.
User property is: changes.removeSnapshotSuffix.
<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.
<skipSnapshots> boolean 2.7 Flag controlling snapshot processing. If set, versions ending with -SNAPSHOT won't be checked.
Default value is: false.
User property is: changes.skipSnapshots.
<xmlPath> File 2.4 The path of the changes.xml file that will be checked.
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

<failOnError>

Mojo failure in case of exception when getting no release for supplied arguments. If false only a warning will be logged.
  • Type: boolean
  • Since: 2.4
  • Required: No
  • User Property: changes.check.failOnError
  • Default: true

<releaseDateFormat>

The format that a correct release date should have. This value will be used as a pattern to try to parse a date.
  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • User Property: changes.releaseDateFormat
  • Default: yyyy-MM-dd

<releaseDateLocale>

The locale that a correct release date should have. This value will be used as a locale to try to parse a date.
  • Type: java.lang.String
  • Since: 2.10
  • Required: No
  • User Property: changes.releaseDateLocale

<removeSnapshotSuffix>

If "-SNAPSHOT" suffix should be removed when searching for issues.
  • Type: boolean
  • Since: 2.12.3
  • Required: No
  • User Property: changes.removeSnapshotSuffix
  • Default: true

<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

<skipSnapshots>

Flag controlling snapshot processing. If set, versions ending with -SNAPSHOT won't be checked.
  • Type: boolean
  • Since: 2.7
  • Required: No
  • User Property: changes.skipSnapshots
  • Default: false

<version>

Version of the artifact.
  • Type: java.lang.String
  • Since: 2.4
  • Required: Yes
  • User Property: changes.version
  • Default: ${project.version}

<xmlPath>

The path of the changes.xml file that will be checked.
  • Type: java.io.File
  • Since: 2.4
  • Required: No
  • User Property: changes.xmlPath
  • Default: src/changes/changes.xml