tycho-p2-repository:assemble-repository

Full name:

org.eclipse.tycho:tycho-p2-repository-plugin:4.0.0:assemble-repository

Description:

Aggregates content into a p2 repository in ${project.build.directory}/repository.

  1. Copies resources (if any) from ${project.build.outputDirectory} to ${project.build.directory}/repository. This allows to include additional files such as index.html or about files from src/main/resources (or elsewhere) into the p2 repository.
  2. The p2 aggregation into ${project.build.directory}/repository runs recursively: it starts with the content published in the current module, and traverses all artifacts that are marked as included in already aggregated artifacts. (The following artifacts can include other artifacts: categories, products, and features. Note: Dependencies with a strict version range, i.e. a range which only matches exactly one version of an artifact, are also considered as inclusions.)

Attributes:

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

Optional Parameters

Name Type Since Description
<addIUTargetRepositoryReferences> boolean - if enabled all P2 repositories referenced in the IU location type of target-files are added as referenced sites
<addPomRepositoryReferences> boolean - if enabled all P2 repositories referenced in the pom are added as referenced sites
<categoriesDirectory> File - The directory where category.xml files are located.

Defaults to the project's base directory.


Default value is: ${project.basedir}.
<compress> boolean -

Compress the repository index files content.xml and artifacts.xml.


Default value is: true.
<createArtifactRepository> boolean -

By default, this goal creates a p2 repository. Set this to false if only a p2 metadata repository (without the artifact files) shall be created.


Default value is: true.
<extraArtifactRepositoryProperties> Map<String,String> - (no description)
<filterProvided> boolean - If enabled, units and artifacts that are part of a referenced repository are excluded from the mirror operation. This can be used (together with includeAllDependencies) to build a repository that is both self contained and minimal in regard to the referenced repositories)
Default value is: false.
<generateOSGiRepository> boolean - If enabled, an OSGi Repository is generated out of the content of the P2 repository.
<includeAllDependencies> boolean -

By default, only (transitive) inclusions of the published artifacts are aggregated. Set this parameter to true to aggregate all transitive dependencies, making the resulting p2 repository self-contained.


Default value is: false.
<includeAllSources> boolean -

By default, only explicitly mentioned sources are included. Set this parameter to true to include all sources that are available and included in this repository.


Default value is: false.
<includeRequiredFeatures> boolean -

By default, only included features of a feature are included in the repository, setting this to true will also include features mentioned in the dependencies section.

Important Notes:

Due to current restrictions of P2 requirement model even if this is disabled, features with a strict version range are always included, even if they are part of the dependencies of a feature!

Due to current data structure restrictions of P2 Slicer also transitive dependencies of a feature are included and not only the feature itself!


Default value is: false.
<includeRequiredPlugins> boolean -

By default, only included plugins of a feature are included in the repository, setting this to true will also include plugins mentioned in the dependencies section of a feature

Important Notes:

Due to current restrictions of P2 requirement model even if this is disabled, plugins with a strict version range are always included, even if they are part of the dependencies of a feature!

Due to current data structure restrictions of P2 Slicer also transitive dependencies of a plugin might be included and not only the dependency plugin itself!


Default value is: false.
<keepNonXzIndexFiles> boolean -

If xzCompress is true, whether jar or xml index files should be kept in addition to XZ-compressed index files. This fallback provides backwards compatibility for pre-Mars p2 clients which cannot read XZ-compressed index files.


Default value is: true.
<profileProperties> Map<String,String> -

Additional properties against which p2 filters are evaluated while aggregating.


<repositoryFileName> String - Specify the filename of the additionally generated OSGi Repository (if enabled)
Default value is: repository.xml.
<repositoryLocation> File - (no description)
<repositoryName> String -

The name attribute stored in the created p2 repository.


Default value is: ${project.name}.
<xzCompress> boolean -

Add XZ-compressed repository index files. XZ offers better compression ratios esp. for highly redundant file content.


Default value is: true.

Parameter Details

<addIUTargetRepositoryReferences>

if enabled all P2 repositories referenced in the IU location type of target-files are added as referenced sites
  • Type: boolean
  • Required: No

<addPomRepositoryReferences>

if enabled all P2 repositories referenced in the pom are added as referenced sites
  • Type: boolean
  • Required: No

<categoriesDirectory>

The directory where category.xml files are located.

Defaults to the project's base directory.

  • Type: java.io.File
  • Required: No
  • Default: ${project.basedir}

<compress>

Compress the repository index files content.xml and artifacts.xml.

  • Type: boolean
  • Required: No
  • Default: true

<createArtifactRepository>

By default, this goal creates a p2 repository. Set this to false if only a p2 metadata repository (without the artifact files) shall be created.

  • Type: boolean
  • Required: No
  • Default: true

<extraArtifactRepositoryProperties>

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

<filterProvided>

If enabled, units and artifacts that are part of a referenced repository are excluded from the mirror operation. This can be used (together with includeAllDependencies) to build a repository that is both self contained and minimal in regard to the referenced repositories)
  • Type: boolean
  • Required: No
  • Default: false

<generateOSGiRepository>

If enabled, an OSGi Repository is generated out of the content of the P2 repository.
  • Type: boolean
  • Required: No

<includeAllDependencies>

By default, only (transitive) inclusions of the published artifacts are aggregated. Set this parameter to true to aggregate all transitive dependencies, making the resulting p2 repository self-contained.

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

<includeAllSources>

By default, only explicitly mentioned sources are included. Set this parameter to true to include all sources that are available and included in this repository.

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

<includeRequiredFeatures>

By default, only included features of a feature are included in the repository, setting this to true will also include features mentioned in the dependencies section.

Important Notes:

Due to current restrictions of P2 requirement model even if this is disabled, features with a strict version range are always included, even if they are part of the dependencies of a feature!

Due to current data structure restrictions of P2 Slicer also transitive dependencies of a feature are included and not only the feature itself!


<includeRequiredPlugins>

By default, only included plugins of a feature are included in the repository, setting this to true will also include plugins mentioned in the dependencies section of a feature

Important Notes:

Due to current restrictions of P2 requirement model even if this is disabled, plugins with a strict version range are always included, even if they are part of the dependencies of a feature!

Due to current data structure restrictions of P2 Slicer also transitive dependencies of a plugin might be included and not only the dependency plugin itself!


<keepNonXzIndexFiles>

If xzCompress is true, whether jar or xml index files should be kept in addition to XZ-compressed index files. This fallback provides backwards compatibility for pre-Mars p2 clients which cannot read XZ-compressed index files.


<profileProperties>

Additional properties against which p2 filters are evaluated while aggregating.


<repositoryFileName>

Specify the filename of the additionally generated OSGi Repository (if enabled)

<repositoryLocation>

(no description)

<repositoryName>

The name attribute stored in the created p2 repository.


<xzCompress>

Add XZ-compressed repository index files. XZ offers better compression ratios esp. for highly redundant file content.