Skip to content

Latest commit

 

History

History
49 lines (38 loc) · 1.89 KB

prepareFeature.md

File metadata and controls

49 lines (38 loc) · 1.89 KB

prepareFeature task

The prepareFeature task generates features.json file for user features. The features.json file is JSON file that contains the information found within a feature's ESA manifest file. JSONs are a key requirement for the installation of any Liberty features(s) from a Maven repository.

In Open Liberty and WebSphere Liberty runtime versions 21.0.0.11 and above, this task can prepare the user feature to generate the JSON file.

Dependencies

The featuresBom dependency configuration is used to locate the user feature esa file and to generate features.json. The features.json is generated in the following maven coordinate: ${userfeature.group}:features:{$userfeature.version}.

Examples

  1. Place your user feature ESA file in Maven local repository or Maven Central repository.
  2. Create a features-bom file for the user feature in Maven local repository or Maven Central repository. The features-bom artifact in each groupId provides the bill of materials (BOM) for each Maven artifacts.
<project>
 <modelVersion>4.0.0</modelVersion>
 <groupId>userTest.user.test.features</groupId>
 <artifactId>features-bom</artifactId>
 <version>1.0</version>
 <packaging>pom</packaging>
 <name>user feature bill of materials</name>
 <description>user feature bill of materials</description>

 <dependencyManagement>
   <dependencies>
     <dependency>
       <groupId>userTest.user.test.features</groupId>
       <artifactId>testesa1</artifactId>
       <version>1.0</version>
       <type>esa</type>
       <scope>provided</scope>
     </dependency>
   </dependencies>
 </dependencyManagement>
</project>
  1. Provide the Maven coordinate of the custom made features-bom file:
apply plugin: 'liberty'

dependencies {
   featuresBom 'userTest.user.test.features:features-bom:1.0'
}
  1. Install the user feature using the installFeature task.