tycho-source:feature-source

Full name:

org.eclipse.tycho:tycho-source-plugin:5.0.0-SNAPSHOT:feature-source

Description:

Generates a source feature for projects of packaging type eclipse-feature. By default, the generated source feature

  • Declares feature id <originalFeatureId>.source
  • Declares feature label "<originalFeatureLabel> Developer Resources"
  • If present, reuses feature provider, description, copyright and license as well as respective URLs from <originalFeature>
  • Includes all plugins included by <originalFeature>, but each with .source appended to each plugin id
  • Includes all features included by <originalFeature>, but each with .source appended to each feature id
  • Includes the original feature. This ensures that binaries and corresponding sources match.
Source feature generation can be customized by adding files under path sourceTemplateFeature/. Files added here will be added to the root of the source feature jar. Especially, if file sourceTemplateFeature/feature.properties is found, values in this file override values of respective keys in <originalFeature>/feature.properties.

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
<archive> MavenArchiveConfiguration - No description.
<brandingPlugin> String - Use this to explicitly set the branding plugin attribute of the generated source feature (overrides reuseBrandingPlugin).
<excludes> PlexusConfiguration - Bundles and features that do not have corresponding sources. Example:
<excludes>
  <plugin id="plugin.nosource"/>
  <feature id="feature.nosource"/>
</excludes>
<finalName> String - The filename to be used for the generated archive file. For the source-feature goal, "-sources-feature" is appended to this filename.
User Property: project.build.finalName
<includeBinaryFeature> boolean - Whether to add an include dependency from the source feature to the corresponding binary feature. If true, this ensures the version of the installed sources matches the binaries.
Default: true
<labelSuffix> String - Source feature label suffix. Unless explicitly provided in sourceTemplateFeature/feature.properties, this suffix will be appended to the original feature label to construct the source feature label.
Default: Developer Resources
<missingSourcesAction> SourceFeatureMojo$MissingSourcesAction - No description.
Default: WARN
<plugins> PlexusConfiguration - Additional plugins to include in the generated source feature. Beware that these additional plugins are not considered during build target platform calculation and ordering of reactor projects. Use <extraRequirements> dependency resolver configuration to guarantee proper reactor build order.

WARNING This experimental parameter may be removed from future source-feature mojo versions without prior notice.

<reuseBrandingPlugin> boolean - Whether to reuse an explicit branding plugin from the binary feature for the generated source feature.
Default: true
<skip> boolean - Whether to skip source feature generation.
Default: false
<useDefaultExcludes> boolean - No description.
Default: true

Parameter Details

<archive>

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

<brandingPlugin>

Use this to explicitly set the branding plugin attribute of the generated source feature (overrides reuseBrandingPlugin).
  • Type: java.lang.String
  • Required: No

<excludes>

Bundles and features that do not have corresponding sources. Example:
<excludes>
  <plugin id="plugin.nosource"/>
  <feature id="feature.nosource"/>
</excludes>
  • Type: org.codehaus.plexus.configuration.PlexusConfiguration
  • Required: No

<finalName>

The filename to be used for the generated archive file. For the source-feature goal, "-sources-feature" is appended to this filename.
  • Type: java.lang.String
  • Required: No
  • User Property: project.build.finalName

<includeBinaryFeature>

Whether to add an include dependency from the source feature to the corresponding binary feature. If true, this ensures the version of the installed sources matches the binaries.
  • Type: boolean
  • Required: No
  • Default: true

<labelSuffix>

Source feature label suffix. Unless explicitly provided in sourceTemplateFeature/feature.properties, this suffix will be appended to the original feature label to construct the source feature label.
  • Type: java.lang.String
  • Required: No
  • Default: Developer Resources

<missingSourcesAction>

No description.
  • Type: org.eclipse.tycho.source.SourceFeatureMojo$MissingSourcesAction
  • Required: No
  • Default: WARN

<plugins>

Additional plugins to include in the generated source feature. Beware that these additional plugins are not considered during build target platform calculation and ordering of reactor projects. Use <extraRequirements> dependency resolver configuration to guarantee proper reactor build order.

WARNING This experimental parameter may be removed from future source-feature mojo versions without prior notice.

  • Type: org.codehaus.plexus.configuration.PlexusConfiguration
  • Required: No

<reuseBrandingPlugin>

Whether to reuse an explicit branding plugin from the binary feature for the generated source feature.
  • Type: boolean
  • Required: No
  • Default: true

<skip>

Whether to skip source feature generation.
  • Type: boolean
  • Required: No
  • Default: false

<useDefaultExcludes>

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