Chapter 2. Getting started

Procedure

1. Clone the Maven plugin Github repository:

   $ git clone https://github.com/windup/windup-maven-plugin.git

2. Navigate to the windup-maven-plugin directory.

   $ cd windup-maven-plugin

3. Build the project:

   $ mvn clean install

   The windup-maven-plugin jar is installed in your local Maven repository.

Procedure

1. Add the following <plugin> to your application’s pom.xml file:

   [...]
   <plugin>
       <groupId>org.jboss.windup.plugin</groupId>
       <artifactId>windup-maven-plugin</artifactId>
       <version>5.0.Final</version>
       <executions>
           <execution>
               <id>run-windup</id>
               <phase>package</phase>
               <goals>
                   <goal>windup</goal>
               </goals>
           </execution>
       </executions>
       <configuration>
           <offlineMode>true</offlineMode> 1
       </configuration>
   </plugin>
   [...]

   1

   offlineMode runs the Maven plugin in offline mode, disabling network features to improve performance.

2. If using Java 11, then --add-modules=java.se must be added to the MAVEN_OPTS environment variable. When using older versions of Java this is not necessary, and you can proceed to the next step.

   export MAVEN_OPTS=--add-modules=java.se

   Important

   Using the Maven plugin on Java 11 is provided as Technology Preview only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend to use them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.

   See Technology Preview Features support scope on the Red Hat Customer Portal for information about the support scope for Technology Preview features.

3. Build the project:

   $ mvn clean install

   You can access the generated reports.

1. Include the following plugin inside the parent project’s pom.xml. The following is a sample pom.xml for a parent module.

   <plugin>
       <groupId>org.jboss.windup.plugin</groupId>
       <artifactId>windup-maven-plugin</artifactId>
       <version>5.0.Final</version>
       <inherited>false</inherited>
       <executions>
           <execution>
               <id>run-windup</id>
               <phase>package</phase>
               <goals>
                   <goal>windup</goal>
               </goals>
           </execution>
       </executions>
       <configuration>
           <input>${project.basedir}</input>
           <offlineMode>true</offlineMode>
           <windupHome>>/PATH/TO/CLI/<</windupHome>
       </configuration>
   </plugin>

   This pom.xml file differs from the default in the following attributes:

   • inherited: Defined at the plugin level, this attribute indicates whether or not this configuration should be used in child modules. Set to false for performance improvements.
   • input: Specifies the path to the directory containing the projects to be analyzed. This attribute defaults to {project.basedir}/src/main, and should be defined if the parent project does not have source code to analyze.

   • windupHome: A path to an extracted copy of the MTA CLI. This attribute is optional, but is recommended as a performance improvement.

     The above example demonstrates a set of recommended arguments.

2. Build the parent project. During the build process the Maven plugin will execute against all children in the project without further configuration.

   $ mvn clean install

3. Once completed, you can access the generated reports. This report contains the analysis for the parent and all children.