Repository navigation
document plugin.xml V4 vs V3 - #13253
Conversation
gnodet-bot
left a comment
There was a problem hiding this comment.
Documentation PR, so no code correctness issues. Two accuracy problems to fix before merging.
This review was generated by an AI agent, Hermès on behalf of @gnodet.
gnodet-bot
left a comment
There was a problem hiding this comment.
Re-review after second commit. All four previous findings have been addressed — grammar fix, wrong defaultValue removed, empty descriptions filled in, stray blank line in site.xml gone. Two empty descriptions remain.
This review was generated by an AI agent, Hermès on behalf of @gnodet.
gnodet-bot
left a comment
There was a problem hiding this comment.
Re-review after third commit. All previous findings are addressed — the two remaining empty descriptions on Parameter.implementation and Configuration.implementation are now filled, matching the suggestions from the prior review. One minor grammar issue remains.
This review was generated by an AI agent, Hermès on behalf of @gnodet.
gnodet-bot
left a comment
There was a problem hiding this comment.
Re-review after commits 95110dc7 and 9b3d5071. All remaining findings from the previous review have been addressed:
- ✅
Parameter.implementationdescription filled in (V3 mdo) - ✅
Configuration.implementationdescription filled in (V3 mdo) - ✅ All 8 empty descriptions in the V4 mdo filled in (
goalPrefix,isolatedRealm,inheritedByDefault,executeLifecycle,composer,parameters,resolutions,roleHint)
The removal of the lifecycle-mappings.html menu item from compat/maven-plugin-api/site.xml is also correct — there is no lifecycle .mdo source in that module, so the link was dead before this PR.
Documentation is now complete and accurate. Ready to merge.
This review was generated by an AI agent, Hermès on behalf of @gnodet.
|
given this Maven 3 |
- 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'
9b3d507 to
3de82b7
Compare
Backport of apache#13253 to maven-3.10.x. - Fill in missing descriptions for goalPrefix, isolatedRealm, inheritedByDefault, executeLifecycle, composer, parameters and roleHint fields in maven-plugin-api/src/main/mdo/plugin.mdo - Clarify 'Maven 3 plugin' in index.md - Update site.xml to rename the plugin.xml menu entry - Update maven-compat/src/site/markdown/index.md title - Fix cross-link to Maven 4 plugin descriptor: use absolute URL (relative ../../api/maven-api-plugin/ path is invalid on maven-3.10.x)
Backport of apache#13253 to maven-3.10.x. Fills in previously empty descriptions for the following fields in maven-plugin-api/src/main/mdo/plugin.mdo: - goalPrefix, isolatedRealm, inheritedByDefault (PluginDescriptor) - executeLifecycle, composer, parameters (MojoDescriptor) - roleHint (Requirement)
- Fill in previously empty descriptions in V4 plugin.mdo: goalPrefix, isolatedRealm, inheritedByDefault, executeLifecycle, composer, parameters, resolutions, roleHint - Add V3 plugin.mdo with documented fields in compat/maven-plugin-api - Add modello xdoc execution in compat/maven-plugin-api for documentation generation - Clean up site.xml: remove dead lifecycle-mappings.html nav entry Backport of #13253 to maven-4.0.x.
- Fill in previously empty descriptions in plugin.mdo: goalPrefix, isolatedRealm, inheritedByDefault (PluginDescriptor), executeLifecycle, composer, parameters (MojoDescriptor), roleHint (Requirement) - Version tags kept at 1.0.0 (V3 semantics, no V4+ fields) - Clean up site.xml: remove dead lifecycle-mappings.html nav entry - Update index.md to match source PR documentation Backport of #13253 to maven-3.10.x.
plugin.xml V3 is quite different from V4: we need 2 separate docs, even if they cross-link for Maven 3 Plugins vs Maven 4 Plugins
(to be backported to 4.0.x)