Repository navigation
docs: document plugin.xml V4 vs V3 - #13260
Conversation
- Add dedicated site documentation for the V3 plugin.mdo model in compat/maven-plugin-api, cross-linking to the V4 documentation - Add dedicated site documentation for the V4 plugin.mdo model in api/maven-api-plugin, cross-linking to the V3 documentation - Fill in missing descriptions for goalPrefix, isolatedRealm, inheritedByDefault, executeLifecycle, composer, parameters, configuration and roleHint fields in both V3 and V4 plugin.mdo - Remove incorrect defaultValue 'runtime' from requiresDependencyResolution (MojoDescriptor initialises this field to null by default) - Fix grammar: 'immutable models' -> 'immutable model' in index.md - Fix typo: 'wrong this documentation' -> 'wrong with this documentation'
gnodet-bot
left a comment
gnodet-bot
left a comment
There was a problem hiding this comment.
Backport of #13253 reviewed and approved.
Docs and model (V3 + V4): All previously empty descriptions are now filled in — goalPrefix, isolatedRealm, inheritedByDefault, executeLifecycle, composer, parameters, resolutions, roleHint in the V4 mdo; full model with documented fields in the new V3 mdo. Zero empty descriptions remain in either file. {@code} usage consistent with the established V4 mdo convention.
compat/maven-plugin-api/pom.xml: Modello xdoc execution added at generate-sources phase — documentation generation only, no behaviour change, no new compat-layer logic. Version inherited from parent pluginManagement (2.8.1). No explicit pin needed.
site.xml: Dropping the lifecycle-mappings.html nav entry is correct — that file was never generated (no modello lifecycle execution was configured in this module before this PR, on either maven-4.0.x or master), so the entry was a dead link.
Links: Relative paths in .md files (./plugin.html, ../../api/maven-api-plugin/) are consistent with the site layout.
Note: This backport lands while the original PR #13253 is not yet merged to master — the commit 4398d6569d referenced in the PR body is a branch commit, not a master commit. The content is approved there, so no functional concern — but the ordering should be confirmed by the original author (@hboutemy) before merge.
This review was generated by an AI agent, Hermès on behalf of @gnodet.
3 participants
Backport of #13253 (4398d65) to
maven-4.0.x.Cherry-pick applied cleanly with no conflicts.