bundle:baseline

Full name:

org.apache.felix:maven-bundle-plugin:4.2.1:baseline

Description:

BND Baseline check between two bundles.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.4.1.
  • Binds by default to the lifecycle phase: verify.

Optional Parameters

Name Type Since Description
comparisonArtifactId String 2.4.1 Artifact to compare the current code against.
Default value is: ${project.artifactId}.
User property is: comparisonArtifactId.
comparisonClassifier String 2.4.1 Classifier for the artifact to compare the current code against.
User property is: comparisonClassifier.
comparisonGroupId String 2.4.1 Group id to compare the current code against.
Default value is: ${project.groupId}.
User property is: comparisonGroupId.
comparisonPackaging String 2.4.1 Artifact to compare the current code against.
Default value is: ${project.packaging}.
User property is: comparisonPackaging.
comparisonVersion String 2.4.1 Version to compare the current code against.
Default value is: (,${project.version}).
User property is: comparisonVersion.
failOnError boolean 2.4.1 Whether to fail on errors.
Default value is: true.
User property is: baseline.failOnError.
failOnWarning boolean 2.4.1 Whether to fail on warnings.
Default value is: false.
User property is: baseline.failOnWarning.
filters String[] 2.4.1 A list of packages filter, if empty the whole bundle will be traversed. Values are specified in OSGi package instructions notation, e.g. !org.apache.felix.bundleplugin.
logResults boolean 2.4.1 Whether to log the results to the console or not, true by default.
Default value is: true.
User property is: logResults.
skip boolean 2.4.1 Flag to easily skip execution.
Default value is: false.
User property is: baseline.skip.
supportedProjectTypes List 2.4.1 Project types which this plugin supports.
xmlOutputFile File 2.4.1 An XML output file to render to ${project.build.directory}/baseline.xml.
Default value is: ${project.build.directory}/baseline.xml.

Parameter Details

comparisonArtifactId:

Artifact to compare the current code against.
  • Type: java.lang.String
  • Since: 2.4.1
  • Required: No
  • User Property: comparisonArtifactId
  • Default: ${project.artifactId}

comparisonClassifier:

Classifier for the artifact to compare the current code against.
  • Type: java.lang.String
  • Since: 2.4.1
  • Required: No
  • User Property: comparisonClassifier

comparisonGroupId:

Group id to compare the current code against.
  • Type: java.lang.String
  • Since: 2.4.1
  • Required: No
  • User Property: comparisonGroupId
  • Default: ${project.groupId}

comparisonPackaging:

Artifact to compare the current code against.
  • Type: java.lang.String
  • Since: 2.4.1
  • Required: No
  • User Property: comparisonPackaging
  • Default: ${project.packaging}

comparisonVersion:

Version to compare the current code against.
  • Type: java.lang.String
  • Since: 2.4.1
  • Required: No
  • User Property: comparisonVersion
  • Default: (,${project.version})

failOnError:

Whether to fail on errors.
  • Type: boolean
  • Since: 2.4.1
  • Required: No
  • User Property: baseline.failOnError
  • Default: true

failOnWarning:

Whether to fail on warnings.
  • Type: boolean
  • Since: 2.4.1
  • Required: No
  • User Property: baseline.failOnWarning
  • Default: false

filters:

A list of packages filter, if empty the whole bundle will be traversed. Values are specified in OSGi package instructions notation, e.g. !org.apache.felix.bundleplugin.
  • Type: java.lang.String[]
  • Since: 2.4.1
  • Required: No

logResults:

Whether to log the results to the console or not, true by default.
  • Type: boolean
  • Since: 2.4.1
  • Required: No
  • User Property: logResults
  • Default: true

skip:

Flag to easily skip execution.
  • Type: boolean
  • Since: 2.4.1
  • Required: No
  • User Property: baseline.skip
  • Default: false

supportedProjectTypes:

Project types which this plugin supports.
  • Type: java.util.List
  • Since: 2.4.1
  • Required: No

xmlOutputFile:

An XML output file to render to ${project.build.directory}/baseline.xml.
  • Type: java.io.File
  • Since: 2.4.1
  • Required: No
  • Default: ${project.build.directory}/baseline.xml