Skip to content

Add Markdown usage documentation for the Advisor Maven Plugin#45

Draft
Copilot wants to merge 4 commits intomainfrom
copilot/create-command-line-usage-doc
Draft

Add Markdown usage documentation for the Advisor Maven Plugin#45
Copilot wants to merge 4 commits intomainfrom
copilot/create-command-line-usage-doc

Conversation

Copy link

Copilot AI commented Mar 13, 2026

The issue requested user-facing Markdown documentation for the plugin's CLI usage, not a programmatic help goal.

Changes

  • Removed HelpMojo.java and HelpMojoTest.java — wrong implementation (a Maven goal, not docs)
  • Added docs/usage.md — full usage reference covering:
    • Both goals (advise, microprofile-advise) with parameter tables, supported version matrices, and examples
    • Covered Jakarta EE and MicroProfile specifications per version
    • Output format: severity levels ([ERROR] / [WARNING] / [INFO]) with an annotated real-world example
    • pom.xml configuration alternative to CLI -D flags
    • Unit and integration test instructions
  • Rewrote README.md — replaced the informal step-by-step prose with a concise description, supported-paths table, quick-start commands, and a link to docs/usage.md for full reference

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

Copilot AI and others added 2 commits March 13, 2026 02:59
Co-authored-by: jGauravGupta <15934072+jGauravGupta@users.noreply.github.com>
Co-authored-by: jGauravGupta <15934072+jGauravGupta@users.noreply.github.com>
Copilot AI changed the title [WIP] Add command line usage documentation Add help goal to display command line usage documentation Mar 13, 2026
Copilot AI requested a review from jGauravGupta March 13, 2026 03:00
Co-authored-by: jGauravGupta <15934072+jGauravGupta@users.noreply.github.com>
Copilot AI changed the title Add help goal to display command line usage documentation Add Markdown usage documentation for the Advisor Maven Plugin Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants