Skip to content

Document skipNativeBuildForPom for Maven aggregators #921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jormundur00 merged 2 commits into from
Jul 15, 2026
+13 −0
Merged

Document skipNativeBuildForPom for Maven aggregators #921

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
033e226
Document skipNativeBuildForPom Maven option
jormundur00 Jun 9, 2026
9fdd9eb
Remove internal citation from Maven docs
jormundur00 Jun 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/src/docs/asciidoc/maven-plugin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,19 @@ The following configuration options are available:
----
<skipNativeBuild>true</skipNativeBuild>
----
`<skipNativeBuildForPom>`::
To skip generation of the native image only for Maven projects with `pom` packaging, use

@vjovanov vjovanov Jul 15, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we infer this from the project?

@jormundur00 jormundur00 Jul 15, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The plugin already infers pom packaging when this option is enabled. We keep it opt-in because packaging alone does not tell us whether a project is intended to build a native image: a POM project can still provide an explicit classpath and main class.

Without this option, users need to avoid inheriting the native execution into the aggregator—for example, put it separately in every application module, or keep configuration in pluginManagement and add executions in each leaf. That is more verbose and easier to misconfigure in a larger reactor.

skipNativeBuildForPom is therefore a convenience for shared native-plugin configuration: it skips the aggregator execution while application modules continue to build normally.

`<skipNativeBuildForPom>`. This option defaults to `false` for compatibility. It is useful in
multi-module builds where a parent aggregator POM shares the native profile or plugin
configuration with child modules but does not contain the application main class. Enabling this
option prevents native image generation in the aggregator project while still allowing
application modules to build their native images. It does not select the application module
automatically; configure or run the native build in the module that owns the main class. To
enable it, add:
[source,xml, role="multi-language-sample"]
----
<skipNativeBuildForPom>true</skipNativeBuildForPom>
----
`<skipNativeTests>`::
To skip generation and execution of the native image compiled tests, add:
[source,xml, role="multi-language-sample"]
Expand Down