tycho-packaging:update-consumer-pom

Full name:

org.eclipse.tycho:tycho-packaging-plugin:4.0.5:update-consumer-pom

Description:

Updates the pom file with the dependencies from the tycho model. If you further like to customize the pom you should take a look at the Maven Flatten Plugin

See also Build vs Consumer POM

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.
  • Binds by default to the lifecycle phase: prepare-package.

Required Parameters

Name Type Since Description
<outputDirectory> File - The directory where the tycho generated POM file will be written to.
Default: ${project.basedir}
<tychoPomFilename> String - The filename of the tycho generated POM file.
Default: .tycho-consumer-pom.xml

Optional Parameters

Name Type Since Description
<archive> MavenArchiveConfiguration - No description.
<deleteOnExit> boolean - If deleteOnExit is true the file will be marked for deletion on JVM exit
Default: true
<includeP2Dependencies> boolean - If includeP2Dependencies is true Tycho will include P2 dependencies in the consumer pom as optional items with provided scope. If the value is false, such items are skipped and only such items are included that can be mapped to a valid maven artifact
Default: false
<mapP2Dependencies> boolean - If mapP2Dependencies is true then Tycho tries to reverse-resolve P2 dependencies to true maven artifact coordinates and include those in the pom instead of the P2 system scoped ones.
Default: false
<relativePathFromParent> boolean - If enabled, removes the relative path from the parent
Default: true
<removeBuild> boolean - If enabled, build section is removed from the consumer pom
Default: true
<removeModules> boolean - If enabled, modules are removed from the consumer pom
Default: true
<removeParent> boolean - If enabled, removes the parent and resolves version and group id directly
Default: true
<replacePackagingType> boolean - if enabled, replace the real packaging-type (e.g. eclipse-plugin) with its implied one (e.g. jar). This makes the pom look more like a "plain" one and ensure that such dependencies are not confused by other tools (including maven).
Default: true
<replaceTypeWithExtension> boolean - replace they type of a dependency (e.g. 'eclipse-plugin') with its extension (e.g. 'jar')
Default: true
<resolver> String - No description.
Default: local,p2,central
<skipPomGeneration> Boolean - No description.
<updatePomFile> boolean - Indicate if the generated tycho POM should become the new project.
Default: true

Parameter Details

<archive>

No description.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: report.plugin.goal.no

<deleteOnExit>

If deleteOnExit is true the file will be marked for deletion on JVM exit
  • Type: boolean
  • Required: report.plugin.goal.no
  • Default: true

<includeP2Dependencies>

If includeP2Dependencies is true Tycho will include P2 dependencies in the consumer pom as optional items with provided scope. If the value is false, such items are skipped and only such items are included that can be mapped to a valid maven artifact
  • Type: boolean
  • Required: report.plugin.goal.no
  • Default: false

<mapP2Dependencies>

If mapP2Dependencies is true then Tycho tries to reverse-resolve P2 dependencies to true maven artifact coordinates and include those in the pom instead of the P2 system scoped ones.
  • Type: boolean
  • Required: report.plugin.goal.no
  • Default: false

<outputDirectory>

The directory where the tycho generated POM file will be written to.
  • Type: java.io.File
  • Required: report.plugin.goal.yes
  • Default: ${project.basedir}

<relativePathFromParent>

If enabled, removes the relative path from the parent
  • Type: boolean
  • Required: report.plugin.goal.no
  • Default: true

<removeBuild>

If enabled, build section is removed from the consumer pom
  • Type: boolean
  • Required: report.plugin.goal.no
  • Default: true

<removeModules>

If enabled, modules are removed from the consumer pom
  • Type: boolean
  • Required: report.plugin.goal.no
  • Default: true

<removeParent>

If enabled, removes the parent and resolves version and group id directly
  • Type: boolean
  • Required: report.plugin.goal.no
  • Default: true

<replacePackagingType>

if enabled, replace the real packaging-type (e.g. eclipse-plugin) with its implied one (e.g. jar). This makes the pom look more like a "plain" one and ensure that such dependencies are not confused by other tools (including maven).
  • Type: boolean
  • Required: report.plugin.goal.no
  • Default: true

<replaceTypeWithExtension>

replace they type of a dependency (e.g. 'eclipse-plugin') with its extension (e.g. 'jar')
  • Type: boolean
  • Required: report.plugin.goal.no
  • Default: true

<resolver>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • Default: local,p2,central

<skipPomGeneration>

No description.
  • Type: java.lang.Boolean
  • Required: report.plugin.goal.no

<tychoPomFilename>

The filename of the tycho generated POM file.
  • Type: java.lang.String
  • Required: report.plugin.goal.yes
  • Default: .tycho-consumer-pom.xml

<updatePomFile>

Indicate if the generated tycho POM should become the new project.
  • Type: boolean
  • Required: report.plugin.goal.no
  • Default: true