buildmetadata:build-point

Full name:

de.smartics.maven.plugin:maven-buildmetadata-plugin:1.1.5:build-point

Description:

Adds the build time to the properties file and runs all providers flagged with Provider.RUN_AT_BUILD_POINT .

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: prepare-package.

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.
addToFilters boolean 1.0 Flag to indicate whether or not the generated properties file should be added to the projects filters.

Filters are only added temporarily (read in-memory during the build) and are not written to the POM.


Default value is: true.
createXmlReport boolean 1.0 Flag to choose whether (true) or not (false) the XML report should be created.
Default value is: true.
name String 1.0 The name of the build point to append to the duration property name. If blank, the duration property will be stored as build.duration.

This way build durations may be taken from different phases of the build.
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.
providers List 1.0 The list of meta data providers to launch that contribute to the meta data.
xmlOutputFile File 1.0 The name of the XML report file to write. If you want to include the XML file in the artifact, use ${project.build.outputDirectory}/META-INF/buildmetadata.xml.
Default value is: ${project.build.directory}/buildmetadata.xml.

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

addToFilters:

Flag to indicate whether or not the generated properties file should be added to the projects filters.

Filters are only added temporarily (read in-memory during the build) and are not written to the POM.

  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${buildMetaData.addToFilters}
  • Default: true

createXmlReport:

Flag to choose whether ( true) or not ( false) the XML report should be created.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: true

name:

The name of the build point to append to the duration property name. If blank, the duration property will be stored as build.duration.

This way build durations may be taken from different phases of the build.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

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

providers:

The list of meta data providers to launch that contribute to the meta data.
  • Type: java.util.List
  • Since: 1.0
  • Required: No

xmlOutputFile:

The name of the XML report file to write. If you want to include the XML file in the artifact, use ${project.build.outputDirectory}/META-INF/buildmetadata.xml.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Default: ${project.build.directory}/buildmetadata.xml