Built by Maven

changes:changes-check

Full name:

org.apache.maven.plugins:maven-changes-plugin:3.0.0-M1: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: basedir
<version> String - Version of the artifact.
Default: ${project.version}
User Property: changes.version

Optional Parameters

Name Type Since Description
<releaseDateFormat> String - The format that a correct release date should have. This value will be used as a pattern to try to parse a date.
Default: yyyy-MM-dd
User Property: 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: changes.releaseDateLocale
<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
<skipSnapshots> boolean 2.7 Flag controlling snapshot processing. If set, versions ending with -SNAPSHOT won't be checked.
Default: false
User Property: changes.skipSnapshots
<xmlPath> File - The path of the changes.xml file that will be checked.
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

<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
  • 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

<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
  • 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
  • Required: No
  • User Property: changes.xmlPath
  • Default: src/changes/changes.xml