buildmetadata:buildmetadata-report

Note:This goal should be used as a Maven report.

Full name:

de.smartics.maven.plugin:buildmetadata-maven-plugin:1.7.0:buildmetadata-report

Description:

Generates a report about the meta data provided to the build.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: site.

Optional Parameters

Name Type Since Description
activatePropertyOutputFileMapping boolean 1.1 Used to activate the default mapping that writes the build properties of deployable units to ${project.build.directory}/${project.build.finalName}/META-INF/build.properties and for standard JAR files to ${project.build.outputDirectory}/META-INF/build.properties.
Default value is: true.
createPropertiesReport boolean 1.2 Flag to choose whether (true) or not (false) the build.properties file should be created.

This will adjust the path of the propertiesOutputFile to ${project.build.directory}/build.properties.

This flag allows the report mojo to behave accordingly to that of the build mojo.


Default value is: true.
locale String 1.0 The locale to use regardless of the report. This should be set to the locale the Javadoc comment is written in. If not set, the Maven provided locale is used.
User property is: buildmetadata.locale.
logLevel String 1.0 Specifies the log level buildmetadata.logLevel used for this plugin.

Allowed values are SEVERE, WARNING, INFO and FINEST.


User property is: buildmetadata.logLevel.
properties List 1.0 The list of a system properties or environment variables to be selected by the user to include into the build meta data properties.

The name is the name of the property, the section is relevant for placing the property in one of the following sections:

  • build.scm
  • build.dateAndVersion
  • build.runtime
  • build.java
  • build.maven
  • project
  • build.misc

If no valid section is given, the property is silently rendered in the build.misc section.
propertiesOutputFile File 1.0 The name of the properties file to write. Per default this value is overridden by packaging dependent locations. Please refer to activatePropertyOutputFileMapping for details.
Default value is: ${project.build.outputDirectory}/META-INF/build.properties.
propertyOutputFileMapping List 1.1 Maps a packaging to a location for the build meta data properties file.

This mapping is especially useful for multi projects.
skip boolean 1.0 A simple flag to skip the generation of the reports. If set on the command line use -Dbuildmetadata.skip.
Default value is: false.
User property is: buildmetadata.skip.
skipModules boolean 1.5.0 Flag to indicate that the buildmetadata must only be added for the root project. Modules will be skipped.
Default value is: false.

Parameter Details

activatePropertyOutputFileMapping:

Used to activate the default mapping that writes the build properties of deployable units to ${project.build.directory}/${project.build.finalName}/META-INF/build.properties and for standard JAR files to ${project.build.outputDirectory}/META-INF/build.properties.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • Default: true

createPropertiesReport:

Flag to choose whether (true) or not (false) the build.properties file should be created.

This will adjust the path of the propertiesOutputFile to ${project.build.directory}/build.properties.

This flag allows the report mojo to behave accordingly to that of the build mojo.

  • Type: boolean
  • Since: 1.2
  • Required: No
  • Default: true

locale:

The locale to use regardless of the report. This should be set to the locale the Javadoc comment is written in. If not set, the Maven provided locale is used.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: buildmetadata.locale

logLevel:

Specifies the log level buildmetadata.logLevel used for this plugin.

Allowed values are SEVERE, WARNING, INFO and FINEST.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: buildmetadata.logLevel

properties:

The list of a system properties or environment variables to be selected by the user to include into the build meta data properties.

The name is the name of the property, the section is relevant for placing the property in one of the following sections:

  • build.scm
  • build.dateAndVersion
  • build.runtime
  • build.java
  • build.maven
  • project
  • build.misc

If no valid section is given, the property is silently rendered in the build.misc section.

  • Type: java.util.List
  • Since: 1.0
  • Required: No

propertiesOutputFile:

The name of the properties file to write. Per default this value is overridden by packaging dependent locations. Please refer to activatePropertyOutputFileMapping for details.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Default: ${project.build.outputDirectory}/META-INF/build.properties

propertyOutputFileMapping:

Maps a packaging to a location for the build meta data properties file.

This mapping is especially useful for multi projects.

  • Type: java.util.List
  • Since: 1.1
  • Required: No

skip:

A simple flag to skip the generation of the reports. If set on the command line use -Dbuildmetadata.skip.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: buildmetadata.skip
  • Default: false

skipModules:

Flag to indicate that the buildmetadata must only be added for the root project. Modules will be skipped.
  • Type: boolean
  • Since: 1.5.0
  • Required: No
  • Default: false