Plugin Details

This plugin is useful when you need to create custom bundle variants with additional or modified content. It takes an existing OSGi bundle structure (with META-INF/MANIFEST.MF) and allows you to:

• Include or exclude specific files from the base bundle location
• Add additional files from other locations (like compiled classes, resources, etc.)
• Attach the resulting bundle as an artifact with a custom classifier
• Update the Bundle-Version in the manifest to match the expanded project version

Example Configuration

This example creates a custom bundle by combining a base bundle structure from the custom directory with compiled classes from the build output:

<plugin>
  <groupId>org.eclipse.tycho.extras</groupId>
  <artifactId>tycho-custom-bundle-plugin</artifactId>
  <version>${tycho-version}</version>
  <executions>
    <execution>
      <id>custom-bundle</id>
      <phase>package</phase>
      <goals>
        <goal>custom-bundle</goal>
      </goals>
      <configuration>
        <!-- Base bundle location containing META-INF/MANIFEST.MF -->
        <bundleLocation>${project.basedir}/custom</bundleLocation>
        
        <!-- Classifier for the attached artifact -->
        <classifier>attached</classifier>
        
        <!-- Optional: patterns to include from bundleLocation (default: **/*.*) -->
        <includes>
          <include>**/*.txt</include>
          <include>META-INF/**</include>
        </includes>
        
        <!-- Optional: patterns to exclude from bundleLocation -->
        <excludes>
          <exclude>**/*.bak</exclude>
        </excludes>
        
        <!-- Additional files to include in the bundle -->
        <fileSets>
          <fileSet>
            <directory>${project.build.outputDirectory}</directory>
            <includes>
              <include>**/*.class</include>
            </includes>
          </fileSet>
        </fileSets>
      </configuration>
    </execution>
  </executions>
</plugin>

Requirements

• The bundleLocation directory must contain a valid OSGi manifest file at META-INF/MANIFEST.MF
• The manifest must contain valid OSGi bundle headers (Bundle-SymbolicName, etc.)
• At least one fileSet must be configured to specify additional files to include

Output

The plugin creates a JAR file named <artifactId>-<version>-<classifier>.jar in the project's build directory and attaches it to the project with the specified classifier. The Bundle-Version in the manifest is automatically updated to match the expanded version from the project (including qualifiers).

This plugin supports reproducible builds through the outputTimestamp parameter.