Package org.machanism.machai.gw.maven

Class GWPerModuleMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.machanism.machai.gw.maven.AbstractGWMojo

org.machanism.machai.gw.maven.GWPerModuleMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="gw-per-module",
      aggregator=false,
      threadSafe=true,
      requiresProject=true,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME)
public class GWPerModuleMojo
extends AbstractGWMojo

Maven goal that processes documents across a multi-module (reactor) build.

This goal supports Maven reactor module processing: all submodules are processed according to their dependencies, following standard Maven reactor logic.

Parameters

This goal does not introduce additional parameters beyond those inherited from AbstractGWMojo.

Inherited parameters (from AbstractGWMojo)

• gw.model / <model> (model): Provider/model identifier to pass to the workflow.
• ${basedir} (basedir): Maven module base directory.
• gw.scanDir / <scanDir> (scanDir): Optional scan root override. When omitted, defaults to the module base directory.
• gw.instructions / <instructions> (instructions): Instruction locations (for example, file paths or classpath locations) consumed by the workflow.
• gw.excludes / <excludes> (excludes): Exclude patterns/paths that should be skipped when scanning documentation sources.
• genai.serverId (serverId): settings.xml <server> id used to read GenAI credentials.
• logInputs (logInputs): Whether to log the list of input files passed to the workflow.

  Default: false

Usage examples

Command line

 mvn gw:gw-per-module
 

Override scan root

 mvn gw:gw-per-module -Dgw.scanDir=src\\site
 

Use Maven settings credentials for the GenAI provider

 mvn gw:gw-per-module -Dgenai.serverId=my-model-server
 

Plugin configuration

 <plugin>
   <groupId>org.machanism</groupId>
   <artifactId>gw-maven-plugin</artifactId>
   <version>...</version>
   <configuration>
     <!-- inherited from AbstractGWMojo -->
     <scanDir>${project.basedir}</scanDir>
     <logInputs>true</logInputs>
   </configuration>
 </plugin>
 

Field Summary

Fields inherited from class org.machanism.machai.gw.maven.AbstractGWMojo

basedir, classFunctionTools, excludes, instructions, logger, logInputs, model, project, reactorProjects, scanDir, session

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
GWPerModuleMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

Methods inherited from class org.machanism.machai.gw.maven.AbstractGWMojo

getConfiguration, scanDocuments

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GWPerModuleMojo

public GWPerModuleMojo()

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException