Tycho OSGi Packaging Plugin – tycho-packaging:package-feature

tycho-packaging:package-feature

Full name:

org.eclipse.tycho:tycho-packaging-plugin:4.0.0:package-feature

Description:

(no description)

Attributes:

Requires a Maven project to be executed.
Requires dependency resolution of artifacts in scope: runtime.
The goal is thread-safe and supports parallel builds.
Binds by default to the lifecycle phase: package.

Required Parameters

Name	Type	Since	Description
`<buildDirectory>`	`File`	`-`	The output directory of the jar file By default this is the Maven "target/" directory. User property is: `project.build.directory`.
`<finalName>`	`String`	`-`	Name of the generated JAR. User property is: `project.build.finalName`. Alias is: `jarName`.

Optional Parameters

Name	Type	Since	Description
`<additionalFileSets>`	`DefaultFileSet[]`	`-`	Additional files to be included in the final `.jar`. A typical usage might be when `bin.includes` in `build.properties` is not flexible enough, e.g., for generated files, as when conflicting additional files win over `bin.includes`. Example: <additionalFileSets> <fileSet> <directory>${project.build.directory}/mytool-gen/</directory> <includes> <include>*/</include> </includes> </fileSet> </additionalFileSets> Note: currently, additional file sets are not used for the `package-iu` goal.
`<archive>`	`MavenArchiveConfiguration`	`-`	The maven archiver to use. One of the archiver properties is the `addMavenDescriptor` flag, which indicates whether the generated archive will contain the pom.xml and pom.properties file. If no archive configuration is specified, the default value is `false`. If the maven descriptor should be added to the artifact, use the following configuration: <plugin> <groupId>org.eclipse.tycho</groupId> <artifactId>tycho-packaging-plugin</artifactId> <version>${tycho-version}</version> <configuration> <archive> <addMavenDescriptor>true</addMavenDescriptor> </archive> </configuration> </plugin>
`<basedir>`	`File`	`-`	(no description) User property is: `project.basedir`.
`<deployableFeature>`	`boolean`	`-`	If set to `true`, standard eclipse update site directory with feature content will be created under target folder. Default value is: `false`.
`<featureFile>`	`File`	`-`	The path to the `feature.xml` file. Defaults to the `feature.xml` under the project's base directory. Default value is: `${project.basedir}/feature.xml`.
`<outputDirectory>`	`File`	`-`	The output directory of the jar file By default this is the Maven `target/` directory. User property is: `project.build.directory`.
`<qualifier>`	`String`	`-`	Build qualifier. Recommended way to set this parameter is using build-qualifier goal. User property is: `buildQualifier`.
`<strictBinIncludes>`	`boolean`	`-`	If set to `true` (the default), missing build.properties bin.includes will cause build failure. If set to `false`, missing build.properties bin.includes will be reported as warnings but the build will not fail. Default value is: `true`.
`<target>`	`File`	`-`	(no description) Default value is: `${project.build.directory}/site`.
`<useDefaultExcludes>`	`boolean`	`-`	(no description) Default value is: `true`.

Parameter Details

<additionalFileSets>

Additional files to be included in the final .jar.

A typical usage might be when bin.includes in build.properties is not flexible enough, e.g., for generated files, as when conflicting additional files win over bin.includes.

Example:

<additionalFileSets>
 <fileSet>
  <directory>${project.build.directory}/mytool-gen/</directory>
  <includes>
   <include>**/*</include>
  </includes>
 </fileSet>
</additionalFileSets>

Note: currently, additional file sets are not used for the package-iu goal.

Type: org.codehaus.plexus.archiver.util.DefaultFileSet[]
Required: No

The maven archiver to use. One of the archiver properties is the addMavenDescriptor flag, which indicates whether the generated archive will contain the pom.xml and pom.properties file. If no archive configuration is specified, the default value is false. If the maven descriptor should be added to the artifact, use the following configuration:

<plugin>
  <groupId>org.eclipse.tycho</groupId>
  <artifactId>tycho-packaging-plugin</artifactId>
  <version>${tycho-version}</version>
  <configuration>
    <archive>
      <addMavenDescriptor>true</addMavenDescriptor>
    </archive>
  </configuration>
</plugin>

Type: org.apache.maven.archiver.MavenArchiveConfiguration
Required: No

<basedir>

(no description)

Type: java.io.File
Required: No
User Property: project.basedir

<buildDirectory>

The output directory of the jar file By default this is the Maven "target/" directory.

Type: java.io.File
Required: Yes
User Property: project.build.directory

<deployableFeature>

If set to true, standard eclipse update site directory with feature content will be created under target folder.

Type: boolean
Required: No
Default: false

<featureFile>

The path to the feature.xml file.

Defaults to the feature.xml under the project's base directory.

Type: java.io.File
Required: No
Default: ${project.basedir}/feature.xml

<finalName>

Name of the generated JAR.

Type: java.lang.String
Required: Yes
User Property: project.build.finalName
Alias: jarName

<outputDirectory>

The output directory of the jar file By default this is the Maven target/ directory.

Type: java.io.File
Required: No
User Property: project.build.directory

<qualifier>

Build qualifier. Recommended way to set this parameter is using build-qualifier goal.

Type: java.lang.String
Required: No
User Property: buildQualifier

<strictBinIncludes>

If set to true (the default), missing build.properties bin.includes will cause build failure. If set to false, missing build.properties bin.includes will be reported as warnings but the build will not fail.

Type: boolean
Required: No
Default: true

<target>

(no description)

Type: java.io.File
Required: No
Default: ${project.build.directory}/site

<useDefaultExcludes>

(no description)

Type: boolean
Required: No
Default: true