Fork me on GitHub
Built by Maven

tycho-apitools:verify

Full name:

org.eclipse.tycho:tycho-apitools-plugin:4.0.13:verify

Description:

Performs a PDE-API Tools analysis of this project.

Attributes:

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

Optional Parameters

Name Type Since Description
<apiFilter> File - No description.
Default: ${project.basedir}/.settings/.api_filters
<apiPreferences> File - No description.
Default: ${project.basedir}/.settings/org.eclipse.pde.api.tools.prefs
<apiToolsRepository> Repository - No description.
<baselines> List<Repository> - No description.
User Property: baselines
<debug> boolean - No description.
Default: false
User Property: tycho.apitools.debug
<enhanceLogs> boolean -
Deprecated.
No reason given

* @deprecated Use XML report generated by <report> instead
Default: false
User Property: tycho.apitools.enhanceLogs
<failOnError> boolean - No description.
Default: true
User Property: tycho.apitools.failOnError
<failOnResolutionError> boolean - No description.
Default: false
<failOnVersion> boolean - No description.
Default: false
User Property: tycho.apitools.failOnVersion
<failOnWarning> boolean - No description.
Default: false
User Property: tycho.apitools.failOnWarning
<logDirectory> File -
Deprecated.
Use XML report generated by <report> instead

If given a folder, enhances the ECJ compiler logs with API errors so it can be analyzed by tools understanding that format
Default: ${project.build.directory}/compile-logs
<parallel> boolean - No description.
Default: false
<pluginArtifacts> List<Artifact> - No description.
User Property: plugin.artifacts
<printProblems> boolean - No description.
Default: true
User Property: tycho.apitools.printProblems
<printSummary> boolean - No description.
Default: true
User Property: tycho.apitools.printSummary
<properties> Map<String,String> - No description.
<report> File 4.0.13 The mojo by default also creates an XML report of the API problems. The format is understood by the warnings-ng Jenkins plugin using the native format.

If you make use of this, consider setting <failOnError>false</failOnError> in order to not fail the Maven build on the first bundle with API problems, so that all the reports of all the bundles can be analyzed subsequently by external means.

This may be set to an empty string to skip creation of the XML report.


Default: ${project.build.directory}/apianalysis/report.xml
User Property: tycho.apitools.report
<runAsJob> boolean - Configures if the API Analysis should run as a workspace job, this ensure that no other actions are allowed to run in parallel what sometimes can result in failures to execute the api-analysis
Default: true
User Property: tycho.apitools.runAsJob
<skip> boolean - No description.
Default: false
User Property: tycho.apitools.verify.skip
<skipIfReplaced> boolean - No description.
Default: true
User Property: tycho.apitools.verify.skipIfReplaced
<supportedPackagingTypes> Set<String> - No description.
Default: eclipse-plugin

Parameter Details

<apiFilter>

No description.
  • Type: java.io.File
  • Required: No
  • Default: ${project.basedir}/.settings/.api_filters

<apiPreferences>

No description.
  • Type: java.io.File
  • Required: No
  • Default: ${project.basedir}/.settings/org.eclipse.pde.api.tools.prefs

<apiToolsRepository>

No description.
  • Type: org.apache.maven.model.Repository
  • Required: No

<baselines>

No description.
  • Type: java.util.List<org.apache.maven.model.Repository>
  • Required: No
  • User Property: baselines

<debug>

No description.
  • Type: boolean
  • Required: No
  • User Property: tycho.apitools.debug
  • Default: false

<enhanceLogs>

Deprecated.
No reason given

* @deprecated Use XML report generated by <report> instead
  • Type: boolean
  • Required: No
  • User Property: tycho.apitools.enhanceLogs
  • Default: false

<failOnError>

No description.
  • Type: boolean
  • Required: No
  • User Property: tycho.apitools.failOnError
  • Default: true

<failOnResolutionError>

No description.
  • Type: boolean
  • Required: No
  • Default: false

<failOnVersion>

No description.
  • Type: boolean
  • Required: No
  • User Property: tycho.apitools.failOnVersion
  • Default: false

<failOnWarning>

No description.
  • Type: boolean
  • Required: No
  • User Property: tycho.apitools.failOnWarning
  • Default: false

<logDirectory>

Deprecated.
Use XML report generated by <report> instead

If given a folder, enhances the ECJ compiler logs with API errors so it can be analyzed by tools understanding that format
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/compile-logs

<parallel>

No description.
  • Type: boolean
  • Required: No
  • Default: false

<pluginArtifacts>

No description.
  • Type: java.util.List<org.apache.maven.artifact.Artifact>
  • Required: No
  • User Property: plugin.artifacts

<printProblems>

No description.
  • Type: boolean
  • Required: No
  • User Property: tycho.apitools.printProblems
  • Default: true

<printSummary>

No description.
  • Type: boolean
  • Required: No
  • User Property: tycho.apitools.printSummary
  • Default: true

<properties>

No description.
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<report>

The mojo by default also creates an XML report of the API problems. The format is understood by the warnings-ng Jenkins plugin using the native format.

If you make use of this, consider setting <failOnError>false</failOnError> in order to not fail the Maven build on the first bundle with API problems, so that all the reports of all the bundles can be analyzed subsequently by external means.

This may be set to an empty string to skip creation of the XML report.

  • Type: java.io.File
  • Since: 4.0.13
  • Required: No
  • User Property: tycho.apitools.report
  • Default: ${project.build.directory}/apianalysis/report.xml

<runAsJob>

Configures if the API Analysis should run as a workspace job, this ensure that no other actions are allowed to run in parallel what sometimes can result in failures to execute the api-analysis
  • Type: boolean
  • Required: No
  • User Property: tycho.apitools.runAsJob
  • Default: true

<skip>

No description.
  • Type: boolean
  • Required: No
  • User Property: tycho.apitools.verify.skip
  • Default: false

<skipIfReplaced>

No description.
  • Type: boolean
  • Required: No
  • User Property: tycho.apitools.verify.skipIfReplaced
  • Default: true

<supportedPackagingTypes>

No description.
  • Type: java.util.Set<java.lang.String>
  • Required: No
  • Default: eclipse-plugin