Quarkus Mavenプラグイン

The extensionDescription of the runtime module.

This description is used on https://code.quarkus.io/.

The extensionName of the runtime module. The extensionNames of the extension parent and deployment modules will be based on this name too.

Default: the formatted extensionId

Version of Java used to build the project.

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

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

The artifactId of the Quarkus platform BOM.

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

The version of the Quarkus platform BOM.

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

The version for the newly created Maven modules.

Default: automatic in Quarkus Core else io.quarkus.devtools.commands.CreateExtension.DEFAULT_VERSION

Indicates whether to generate a devmode test for the extension

Indicates whether to generate any tests for the extension (same as -DwithoutUnitTest -DwithoutIntegrationTest -DwithoutDevModeTest)

Artifact ID of the target platform BOM

Version of the target platform BOM

Whether to include license text in the generated SBOM. The default is false

File to store the SBOM in. If not configured, the SBOM will be stored in the ${project.build.directory} directory.

Whether to skip the execution of the goal

INCUBATING option, enabled with @{code -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.

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.

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

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.

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.

This value is intended to be set to true when some generated bytecode is erroneous causing the JVM to crash when the verify:none option is set (which is on by default)

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

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.

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 properties of the plugin.

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

Target launch mode corresponding to io.quarkus.runtime.LaunchMode for which the dependencies should be resolved. io.quarkus.runtime.LaunchMode.TEST is the default, since it includes both provided and test dependency scopes.

The name of the goal for which to show help. If unspecified, all goals will be displayed.

The maximum length of a display line, should be positive.

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 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.

The current repository/network configuration of Maven.

Skips the execution of this mojo

The list of system properties defined for the plugin.

Select the output format among 'name' (display the name only) and 'full' (includes a verbose name and a description).

Only list extensions from given category.

List the already installed extensions

List the already installed extensions

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 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 properties of the plugin.

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

The context of the execution of the plugin.

The current repository/network configuration of Maven.

Skip the execution of this mojo

Additional compiler arguments

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.

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.

This value is intended to be set to true when some generated bytecode is erroneous causing the JVM to crash when the verify:none option is set (which is on by default)

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

For usability reason, this parameter allows removing a single extension.

For usability reason, this parameter allows removing a single extension.

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.

The current repository/network configuration of Maven.

The list of system properties defined for the plugin.

Additional compiler arguments

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.

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.

This value is intended to be set to true when some generated bytecode is erroneous causing the JVM to crash when the verify:none option is set (which is on by default)

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

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

Whether to dump the current build configuration in case the configuration from the previous build isn’t found

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 project’s remote repositories to use for the resolution of artifacts and their dependencies.