Built by Maven

bonita-project:analyze

Full name:

org.bonitasoft.maven:bonita-project-maven-plugin:1.0.0:analyze

Description:

This mojo runs an analysis on the current project dependencies to detect Bonita specific extensions.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator goal.
  • The goal is not marked as thread-safe and thus does not support parallel builds.

Optional Parameters

Name Type Since Description
<excludeScope> String 0.1.0 Scope threshold to exclude, if no value is defined for include. An empty string indicates no dependencies (default).
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:
  • runtime exclude scope excludes runtime and compile dependencies,
  • compile exclude scope excludes compile, provided, and system dependencies,
  • test exclude scope excludes all dependencies, then not really a legitimate option: it will fail, you probably meant to configure includeScope = compile
  • provided exclude scope just excludes provided dependencies,
  • system exclude scope just excludes system dependencies.

User Property: excludeScope
<includeScope> String 0.1.0 Scope threshold to include. An empty string indicates include all dependencies. Default value is runtime.
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:
  • runtime include scope gives runtime and compile dependencies,
  • compile include scope gives compile, provided, and system dependencies,
  • test include scope gives all dependencies (equivalent to default),
  • provided include scope just gives provided dependencies,
  • system include scope just gives system dependencies.

Default: runtime
User Property: includeScope
<outputFile> File - Analysis report output file.
Default: ${project.build.directory}/bonita-dependencies.json
User Property: bonita.analyze.outputFile
<validateDeps> boolean - Look for incompatible dependencies.
Default: true
User Property: bonita.validateDependencies

Parameter Details

<excludeScope>

Scope threshold to exclude, if no value is defined for include. An empty string indicates no dependencies (default).
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:
  • runtime exclude scope excludes runtime and compile dependencies,
  • compile exclude scope excludes compile, provided, and system dependencies,
  • test exclude scope excludes all dependencies, then not really a legitimate option: it will fail, you probably meant to configure includeScope = compile
  • provided exclude scope just excludes provided dependencies,
  • system exclude scope just excludes system dependencies.
  • Type: java.lang.String
  • Since: 0.1.0
  • Required: report.plugin.goal.no
  • User Property: excludeScope

<includeScope>

Scope threshold to include. An empty string indicates include all dependencies. Default value is runtime.
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:
  • runtime include scope gives runtime and compile dependencies,
  • compile include scope gives compile, provided, and system dependencies,
  • test include scope gives all dependencies (equivalent to default),
  • provided include scope just gives provided dependencies,
  • system include scope just gives system dependencies.
  • Type: java.lang.String
  • Since: 0.1.0
  • Required: report.plugin.goal.no
  • User Property: includeScope
  • Default: runtime

<outputFile>

Analysis report output file.
  • Type: java.io.File
  • Required: report.plugin.goal.no
  • User Property: bonita.analyze.outputFile
  • Default: ${project.build.directory}/bonita-dependencies.json

<validateDeps>

Look for incompatible dependencies.
  • Type: boolean
  • Required: report.plugin.goal.no
  • User Property: bonita.validateDependencies
  • Default: true