tycho-packaging:package-plugin

Full name:

org.eclipse.tycho:tycho-packaging-plugin:0.22.0:package-plugin

Description:

Creates a jar-based plugin and attaches it as an artifact

Attributes:

  • Requires a Maven project to be executed.

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.

Optional Parameters

Name Type Since Description
additionalFileSets DefaultFileSet[] - Additional files to be included in the bundle jar. This can be used when bin.includes in build.properties is not flexible enough , e.g. for generated files. If conflicting, additional files win over bin.includes
Example:
<additionalFileSets>
 <fileSet>
  <directory>${project.build.directory}/mytool-gen/</directory>
  <includes>
   <include>**/*</include>
  </includes>
 </fileSet>     
</additionalFileSets>

archive MavenArchiveConfiguration - The maven archiver to use.
qualifier String - Build qualifier. Recommended way to set this parameter is using build-qualifier goal.
User property is: buildQualifier.
sourceReferences SourceReferences - Whether to generate an Eclipse-SourceReferences MANIFEST header. When using this parameter, property ${tycho.scmUrl} must be set and be a valid maven SCM URL. Example configuration:
        <sourceReferences>
          <generate>true</generate>
        </sourceReferences>
Note that a SourceReferencesProvider component must be registered for the SCM type being used. You may also override the generated value by configuring:
        <sourceReferences>
          <generate>true</generate>
          <customValue>scm:myscm:customSourceReferenceValue</customValue>
        </sourceReferences>

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.
useDefaultExcludes boolean - (no description)
Default value is: true.

Parameter Details

additionalFileSets:

Additional files to be included in the bundle jar. This can be used when bin.includes in build.properties is not flexible enough , e.g. for generated files. If conflicting, additional files win over bin.includes
Example:
<additionalFileSets>
 <fileSet>
  <directory>${project.build.directory}/mytool-gen/</directory>
  <includes>
   <include>**/*</include>
  </includes>
 </fileSet>     
</additionalFileSets>
  • Type: org.codehaus.plexus.archiver.util.DefaultFileSet[]
  • Required: No

archive:

The maven archiver to use.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: No

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

finalName:

Name of the generated JAR.
  • Type: java.lang.String
  • Required: Yes
  • User Property: project.build.finalName

qualifier:

Build qualifier. Recommended way to set this parameter is using build-qualifier goal.
  • Type: java.lang.String
  • Required: No
  • User Property: buildQualifier

sourceReferences:

Whether to generate an Eclipse-SourceReferences MANIFEST header. When using this parameter, property ${tycho.scmUrl} must be set and be a valid maven SCM URL. Example configuration:
        <sourceReferences>
          <generate>true</generate>
        </sourceReferences>
Note that a SourceReferencesProvider component must be registered for the SCM type being used. You may also override the generated value by configuring:
        <sourceReferences>
          <generate>true</generate>
          <customValue>scm:myscm:customSourceReferenceValue</customValue>
        </sourceReferences>
  • Type: org.eclipse.tycho.packaging.SourceReferences
  • Required: No

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

useDefaultExcludes:

(no description)
  • Type: boolean
  • Required: No
  • Default: true