Full name:
de.smartics.maven.plugin:buildmetadata-maven-plugin:1.6.1:build-point
Description:
Attributes:
Name | Type | Since | Description |
---|---|---|---|
settingsSecurityLocation | String | 1.4.0 | The location of the settings-security.xml. |
Name | Type | Since | Description |
---|---|---|---|
activateOutputFileMapping | 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. This property is used for the properties and XML build file. 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. User property is: buildMetaData.addToFilters. |
createManifestFile | boolean | 1.5 | Flag to choose whether (true) or not (false) the Manifest file should be created. Default value is: false. |
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. 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. |
manifestFile | File | 1.5 | The location of the Manifest file to add the buildmetadata properties to. Default value is: ${project.build.outputDirectory}/META-INF/MANIFEST.MF. |
manifestSection | String | 1.5 | The name of the section within the Manifest file to write the buildmetadata properties to. Use "Main" to write the the main section. Default value is: BuildMetaData. |
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. |
pluginSelectors | List | 1.5 | Selects properties from plugin configurations. Add a list of selectors like this: <pluginSelectors> <selector> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <keyPrefix>build.runtime.java.compiler.</keyPrefix> <properties> <property>source</property> <property>target</property> </properties> </selector> <selector> ... </selector> </pluginSelectors>
Currently only simple key value pairs are selectable. |
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:
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. |
remoteVersion | String | 1.4.0 | The branch or tag version on the remote server to compare against. If unset, the SCM status will be used to determine the differences. For SVN, leave it blank. For Git, set the version on the remote server (the project's SCM URL points to). |
skip | boolean | 1.0 | A simple flag to skip the generation of the build information. If set on the command line use -DbuildMetaData.skip. Supported by the build point mojo since version 1.5. 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. |
writeProtectFiles | boolean | 1.5 | Flag to choose whether (true) or not (false) to write protect the generated buildmetadata files. Protecting them allows to projects that copy files from different resources together to not override them by other plugins. Default value is: false. |
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. The handling is not in an analogous manner as that of the properties file. The reason is this: we want to keep the artifact as small as possible per default. Therefore we include the build.properties and generate the XML report (see property createXmlReport to the target folder (and not inside META-INF). The XML file can be stored to the artifact server (with a couple of other reports) by the use of the projectmetadata-maven-plugin. Default value is: ${project.build.directory}/buildmetadata.xml. |
xmlOutputFileMapping | List | 1.3 | Maps a packaging to a location for the build meta data XML file. This mapping is especially useful for multi projects. |
This property is used for the properties and XML build file.
Filters are only added temporarily (read in-memory during the build) and are not written to the POM.
This will adjust the path of the propertiesOutputFile to ${project.build.directory}/build.properties.
name:
This way build durations may be taken from different phases of the build.
Add a list of selectors like this:
<pluginSelectors> <selector> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <keyPrefix>build.runtime.java.compiler.</keyPrefix> <properties> <property>source</property> <property>target</property> </properties> </selector> <selector> ... </selector> </pluginSelectors>
Currently only simple key value pairs are selectable.
The name is the name of the property, the section is relevant for placing the property in one of the following sections:
If no valid section is given, the property is silently rendered in the build.misc section.
This mapping is especially useful for multi projects.
For SVN, leave it blank. For Git, set the version on the remote server (the project's SCM URL points to).
skip:
Supported by the build point mojo since version 1.5.
The handling is not in an analogous manner as that of the properties file. The reason is this: we want to keep the artifact as small as possible per default. Therefore we include the build.properties and generate the XML report (see property createXmlReport to the target folder (and not inside META-INF). The XML file can be stored to the artifact server (with a couple of other reports) by the use of the projectmetadata-maven-plugin.
This mapping is especially useful for multi projects.