Quarkus Maven Plugin

Directory where the changes should be performed.

Default: the current directory of the current Java process.

extensionId of this extension (REQUIRED).

It will be used to generate the different extension modules artifactIds ([namespaceId][extensionId]-parent), runtime ([namespaceId][extensionId]) and deployment ([namespaceId][extensionId]-deployment).

The groupId for the newly created Maven modules (REQUIRED - INHERITED IN QUARKUS-CORE).

A prefix common to all extension artifactIds in the current source tree.

Default: "quarkus-" in quarkus Quarkus Core and Quarkiverse else ""

Base package under which classes should be created in Runtime and Deployment modules.

Default: auto-generated out of groupId, namespaceId and extensionId

The groupId of the Quarkus platform BOM.

Default: io.quarkus.devtools.commands.CreateExtension.DEFAULT_BOM_GROUP_ID

Quarkus version the newly created extension should depend on (REQUIRED - INHERITED IN QUARKUS-CORE).

Indicates whether to generate an extension codestart

Indicates whether to generate an integration tests for the extension

Indicates whether to generate a unit test class for the extension

Group ID of the target platform BOM

CycloneDX BOM format. Allowed values are json and xml. The default is json.

Target launch mode corresponding to io.quarkus.runtime.LaunchMode for which the SBOM should be built. io.quarkus.runtime.LaunchMode.NORMAL is the default.

Whether to limit application dependencies to only those that are included in the runtime

Whether to skip the execution of the goal

INCUBATING option, enabled with -Dquarkus.bootstrap.incubating-model-resolver system or project property. Whether to log all dependencies of each dependency node in a tree, adding [+] suffix to those whose dependencies are not expanded.

If specified, this parameter will cause the dependency tree to be written to the path specified, instead of writing to the console.

INCUBATING option, enabled with -Dquarkus.bootstrap.incubating-model-resolver system or project property. Whether to log dependency properties, such as on which classpath they belong, whether they are hot-reloadable in dev mode, etc.

Whether to replace the original JAR with the Uber runner JAR as the main project artifact

Application bootstrap provider ID. This parameter is not supposed to be configured by the user. To be able to re-use an application bootstrapped in one phase in a later phase, there needs to be a way to identify the correct instance of the bootstrapped application (in case there are more than one) in each Mojo. A bootstrap ID serves this purpose. This parameter is set in DevMojo invoking generate-code and generate-code-tests goals. If this parameter is not configured, a Mojo execution ID will be used as the bootstrap ID.

The directory for generated source files.

The list of main manifest attributes

The context of the execution of the plugin.

The properties of the plugin.

The current repository/network configuration of Maven.

Skips the execution of this mojo

The list of system properties defined for the plugin.

Additional compiler arguments

If this server should be started in debug mode. The default is to start in debug mode and listen on port 5005. Whether the JVM is suspended waiting for a debugger to be attached, depends on the value of suspend. debug supports the following options:

Value Effect false The JVM is not started in debug mode true The JVM is started in debug mode and will be listening on debugHost:debugPort client The JVM is started in client mode, and will attempt to connect to debugHost:debugPort {port} The JVM is started in debug mode and will be listening on debugHost:{port}. By default, debugHost has the value "localhost", and debugPort is 5005.

Extension dev mode JVM option filter configuration. Allows disabling all JVM options configured by extensions, for example <extensionJvmOptions> <!-- disable JVM options from all the extensions -→ <disableAll>true</disableAll> </extensionJvmOptions>* or specifying a groupId:artifactId:classifier artifact pattern to disable options provided by the matching subset of extensions, for example <extensionJvmOptions> <disableFor> <!-- disable JVM options from all the extensions with groupId org.acme -→ <extension>org.acme</extension> <!-- disable JVM options configured by io.quarkiverse:quarkus-magic -→ <extension>io.quarkiverse:quarkus-magic</extension> </disableFor> </extensionJvmOptions>

Allows configuring arbitrary JVM arguments. Multiple arguments can be specified by delimiting them with a space character.

Whether changes in the projects that appear to be dependencies of the project containing the application to be launched should trigger hot-reload. By default, they do.

The --release argument to javac.

The -source argument to javac.

The -target argument to javac.

Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format:

groupId:artifactId:classifier:type:version

With the classifier, type and version being optional.

If the type is missing, the artifact is assumed to be of type JAR.

If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates.

However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version.

If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type.

Whether to close the bootstrapped applications after the execution

The list of main manifest attributes

Application launch mode for which to generate the source code.

The properties of the plugin.

The current repository/network configuration of Maven.

Skip the execution of this mojo

Application bootstrap provider ID. This parameter is not supposed to be configured by the user. To be able to re-use an application bootstrapped in one phase in a later phase, there needs to be a way to identify the correct instance of the bootstrapped application (in case there are more than one) in each Mojo. A bootstrap ID serves this purpose. This parameter is set in DevMojo invoking generate-code and generate-code-tests goals. If this parameter is not configured, a Mojo execution ID will be used as the bootstrap ID.

When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: <configuration> <uberJar>true</uberJar> <ignoredEntries> <ignoredEntry>META-INF/BC2048KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC2048KE.DSA</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.DSA</ignoredEntry> </ignoredEntries> </configuration>

The list of manifest sections

The context of the execution of the plugin.

POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.

The project’s remote repositories to use for the resolution of artifacts and their dependencies.

Skip the execution of this mojo

If true, display all settable properties for each goal.

The number of spaces per indentation level, should be positive.

Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format:

groupId:artifactId:classifier:type:version

With the classifier, type and version being optional.

If the type is missing, the artifact is assumed to be of type JAR.

If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates.

However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version.

If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type.

Whether to attach SBOMs generated for Uber JARs as project artifacts

Whether to close the bootstrapped applications after the execution

When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: <configuration> <uberJar>true</uberJar> <ignoredEntries> <ignoredEntry>META-INF/BC2048KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC2048KE.DSA</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.DSA</ignoredEntry> </ignoredEntries> </configuration>

The list of manifest sections

The project’s remote repositories to use for the resolution of plugins and their dependencies.

POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.

The project’s remote repositories to use for the resolution of artifacts and their dependencies.

When the building an Uber JAR, the default JAR is renamed by adding .original suffix. Enabling this property will disable the renaming of the original JAR.

Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format:

groupId:artifactId:classifier:type:version

With the classifier, type and version being optional.

If the type is missing, the artifact is assumed to be of type JAR.

If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates.

However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version.

If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type.

Whether to attach SBOMs generated for Uber JARs as project artifacts

Whether to close the bootstrapped applications after the execution

When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: <configuration> <uberJar>true</uberJar> <ignoredEntries> <ignoredEntry>META-INF/BC2048KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC2048KE.DSA</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.DSA</ignoredEntry> </ignoredEntries> </configuration>

The list of manifest sections

The project’s remote repositories to use for the resolution of plugins and their dependencies.

POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.

The project’s remote repositories to use for the resolution of artifacts and their dependencies.

When the building an Uber JAR, the default JAR is renamed by adding .original suffix. Enabling this property will disable the renaming of the original JAR.

If true, the information will be logged per each relevant module of the project instead of an overall summary

List all extensions or just the installable.

Select the output format among 'id' (display the artifactId only), 'concise' (display name and artifactId) and 'full' (concise format and version related columns).

Search filter on extension list. The format is based on Java Pattern.

Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format:

groupId:artifactId:classifier:type:version

With the classifier, type and version being optional.

If the type is missing, the artifact is assumed to be of type JAR.

If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates.

However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version.

If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type.

Whether to close the bootstrapped applications after the execution

The list of main manifest attributes

The context of the execution of the plugin.

POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.

The project’s remote repositories to use for the resolution of artifacts and their dependencies.

Application bootstrap provider ID. This parameter is not supposed to be configured by the user. To be able to re-use an application bootstrapped in one phase in a later phase, there needs to be a way to identify the correct instance of the bootstrapped application (in case there are more than one) in each Mojo. A bootstrap ID serves this purpose. This parameter is set in DevMojo invoking generate-code and generate-code-tests goals. If this parameter is not configured, a Mojo execution ID will be used as the bootstrap ID.

When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: <configuration> <uberJar>true</uberJar> <ignoredEntries> <ignoredEntry>META-INF/BC2048KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC2048KE.DSA</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.DSA</ignoredEntry> </ignoredEntries> </configuration>

The list of manifest sections

The context of the execution of the plugin.

POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.

The project’s remote repositories to use for the resolution of artifacts and their dependencies.

Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format:

groupId:artifactId:classifier:type:version

With the classifier, type and version being optional.

If the type is missing, the artifact is assumed to be of type JAR.

If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates.

However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version.

If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type.

Whether to close the bootstrapped applications after the execution

The list of main manifest attributes

Application launch mode for which to generate the source code.

The properties of the plugin.

The current repository/network configuration of Maven.

A switch that enables or disables serialization of an io.quarkus.bootstrap.model.ApplicationModel to a file for tests. Deserializing an application model when bootstrapping Quarkus tests has a performance advantage in that the tests will not have to initialize a Maven resolver and re-resolve the application model, which may save, depending on a project, ~80-95% of time on io.quarkus.bootstrap.model.ApplicationModel resolution. Serialization of the test model is enabled by default.

Additional parameters to pass to javac when recompiling changed source files.

When enabled, the <environmentVariables> and <systemPropertyVariables> elements of the Maven Surefire plugin are copied to environment variables and system properties defined by this plugin. Note that no other Surefire configuration is used (notably <systemProperties>), only the 2 elements mentioned above. This plugin’s <environmentVariables> and <systemProperties> have priority, so duplicate keys are not copied.

Since environment variables and system properties are global to the entire process, this also affects dev mode (when executed as quarkus:dev). Because of that, this copying action is disabled by default and requires opt-in.

Whether to enforce the quarkus-maven-plugin build goal to be configured. By default, a missing build goal is considered an inconsistency (although the build goal is not required technically). In this case a warning will be logged and the application will not be started.

This value is intended to be set to true when we want to require C2 compilation instead of preventing it from ever kicking in. Setting this will likely have a small negative effect on startup time and should only be done when it absolutely makes sense.

Allows configuring the modules to add to the application. The listed modules will be added using: --add-modules m1,m2…​.

The directory for compiled classes.

A comma-separated list of Maven plugin keys in groupId:artifactId format (for example org.codehaus.mojo:flatten-maven-plugin and/or goal prefixes, (for example flatten) that should be skipped when quarkus:dev identifies Maven plugin goals that should be executed before the application is launched in dev mode. Only the flatten Maven plugin is skipped by default.

Whether the JVM launch, in debug mode, should be suspended. This parameter is only relevant when the JVM is launched in debug mode. This parameter supports the following values (all the allowed values are case-insensitive): Value Effect y or true The debug mode JVM launch is suspended n or false The debug mode JVM is started without suspending

Selects given test(s) for continuous testing. This is an alternative to quarkus.test.include-pattern and quarkus.test.exclude-pattern; if set, the quarkus.test.[include|exclude]-pattern configuration is ignored. The format of this configuration property is the same as the Maven Surefire -Dtest=…​ format https://maven.apache.org/surefire/maven-surefire-plugin/test-mojo.html#test. Specifically: it is a comma (,) separated list of globs of class file paths and/or method names. Each glob can potentially be prefixed with an exclamation mark (!), which makes it an exclusion filter instead of an inclusion filter. Exclusions have higher priority than inclusions. The class file path glob is separated from the method name glob by the hash sign (#) and multiple method name globs may be present, separated by the plus sign (+).

For example:

The list of extensions to be removed.

The list of extensions to be removed.

Application bootstrap provider ID. This parameter is not supposed to be configured by the user. To be able to re-use an application bootstrapped in one phase in a later phase, there needs to be a way to identify the correct instance of the bootstrapped application (in case there are more than one) in each Mojo. A bootstrap ID serves this purpose. This parameter is set in DevMojo invoking generate-code and generate-code-tests goals. If this parameter is not configured, a Mojo execution ID will be used as the bootstrap ID.

When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: <configuration> <uberJar>true</uberJar> <ignoredEntries> <ignoredEntry>META-INF/BC2048KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC2048KE.DSA</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.DSA</ignoredEntry> </ignoredEntries> </configuration>

The list of manifest sections

The properties of the plugin.

The current repository/network configuration of Maven.

The list of system properties defined for the plugin.

Additional compiler arguments

If this server should be started in debug mode. The default is to start in debug mode and listen on port 5005. Whether the JVM is suspended waiting for a debugger to be attached, depends on the value of suspend. debug supports the following options:

Value Effect false The JVM is not started in debug mode true The JVM is started in debug mode and will be listening on debugHost:debugPort client The JVM is started in client mode, and will attempt to connect to debugHost:debugPort {port} The JVM is started in debug mode and will be listening on debugHost:{port}. By default, debugHost has the value "localhost", and debugPort is 5005.

Extension dev mode JVM option filter configuration. Allows disabling all JVM options configured by extensions, for example <extensionJvmOptions> <!-- disable JVM options from all the extensions -→ <disableAll>true</disableAll> </extensionJvmOptions>* or specifying a groupId:artifactId:classifier artifact pattern to disable options provided by the matching subset of extensions, for example <extensionJvmOptions> <disableFor> <!-- disable JVM options from all the extensions with groupId org.acme -→ <extension>org.acme</extension> <!-- disable JVM options configured by io.quarkiverse:quarkus-magic -→ <extension>io.quarkiverse:quarkus-magic</extension> </disableFor> </extensionJvmOptions>

Allows configuring arbitrary JVM arguments. Multiple arguments can be specified by delimiting them with a space character.

Whether changes in the projects that appear to be dependencies of the project containing the application to be launched should trigger hot-reload. By default, they do.

The --release argument to javac.

The -source argument to javac.

The -target argument to javac.