Built by Maven

tycho-packaging:update-consumer-pom

Full name:

org.eclipse.tycho:tycho-packaging-plugin:4.0.1: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 value is: ${project.basedir}.
<tychoPomFilename> String - The filename of the tycho generated POM file.
Default value is: .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 value is: 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 value is: 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 value is: false.
<relativePathFromParent> boolean - If enabled, removes the relative path from the parent
Default value is: true.
<removeBuild> boolean - If enabled, build section is removed from the consumer pom
Default value is: true.
<removeModules> boolean - If enabled, modules are removed from the consumer pom
Default value is: true.
<removeParent> boolean - If enabled, removes the parent and resolves version and group id directly
Default value is: 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 value is: true.
<replaceTypeWithExtension> boolean - replace they type of a dependency (e.g. 'eclipse-plugin') with its extension (e.g. 'jar')
Default value is: true.
<resolver> String - (no description)
Default value is: local,p2,central.
<skipPomGeneration> Boolean - (no description)
<updatePomFile> boolean - Indicate if the generated tycho POM should become the new project.
Default value is: true.

Parameter Details

<archive>

(no description)
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: No

<deleteOnExit>

If deleteOnExit is true the file will be marked for deletion on JVM exit
  • Type: boolean
  • Required: 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: 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: No
  • Default: false

<outputDirectory>

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

<relativePathFromParent>

If enabled, removes the relative path from the parent
  • Type: boolean
  • Required: No
  • Default: true

<removeBuild>

If enabled, build section is removed from the consumer pom
  • Type: boolean
  • Required: No
  • Default: true

<removeModules>

If enabled, modules are removed from the consumer pom
  • Type: boolean
  • Required: No
  • Default: true

<removeParent>

If enabled, removes the parent and resolves version and group id directly
  • Type: boolean
  • Required: 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: No
  • Default: true

<replaceTypeWithExtension>

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

<resolver>

(no description)
  • Type: java.lang.String
  • Required: No
  • Default: local,p2,central

<skipPomGeneration>

(no description)
  • Type: java.lang.Boolean
  • Required: No

<tychoPomFilename>

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

<updatePomFile>

Indicate if the generated tycho POM should become the new project.
  • Type: boolean
  • Required: No
  • Default: true