apache / apache/maven-plugin-tools

[MPLUGIN-480] Do no longer generate plugin-help.xml for help mojo

Open
#787 0 comments 0 reactions 0 assignees View on GitHub
enhancement priority:major
Dominant language
Java
Stars
64
Forks
71
Avg merge
12h 24m
Merged PRs (30d)
32

Description

**[Konrad Windszus](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=kwin)** opened **[MPLUGIN-480](https://issues.apache.org/jira/browse/MPLUGIN-480?redirect=false)** and commented

Currently the ["helpmojo" goal](https://maven.apache.org/plugin-tools/maven-plugin-plugin/helpmojo-mojo.html) generates a dedicated plugin descriptor named "plugin-help.xml" which ends up in the plugin package next to the regular descriptor. As the former is only a restricted version of the latter, there shouldn't be no need to have a dedicated "plugin-help.xml" in the plugin jar and instead rather rely only on the official descriptor also for the help mojo. Compare with https://maven.apache.org/plugin-tools/index.html#plugin-descriptors

---

**Affects:** 3.9.0

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue identifies the helpmojo goal and plugin descriptors as the entry points; start by tracing how helpmojo produces plugin-help.xml and inspect the related package/output tests. Done means the help mojo no longer adds plugin-help.xml to the plugin JAR while the official descriptor remains available.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.