Rewrite README with usage, status and version guidance - #105
Merged
Conversation
Adds what the component does, a dependency snippet, a usage example checked against Prompter, the Java baseline and documentation links. Notes that the artifact to depend on is plexus-interactivity-api rather than the aggregator, and that a plugin should check interactive mode before prompting so it does not hang a batch build. Drops the 2015 'canonical git repository' line and the dead travis-ci.org badge, which has rendered 'build unknown' since Travis shut down in 2021. Part of codehaus-plexus/.github#58
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of codehaus-plexus/.github#58. Same skeleton as the merged pilots.
Before: badges and
The canonical git repository is located at …. One of those badges was travis-ci.org, which has renderedbuild | unknownsince Travis shut down in 2021 — this was the only repo in the org still carrying it.Three additions worth noting:
What it actually is. "Prompts the user on the console" is abstract; the README now anchors it — the archetype plugin's "Define value for property…" comes from here.
Which artifact.
plexus-interactivity-api, notplexus-interactivity, which is the aggregator. The old README badge pointed at the aggregator.A correctness note. A plugin that prompts should check
isInteractiveMode()first, or it hangs a-Bbuild. That is the sort of thing you only learn by breaking someone's CI.The example is checked against
Prompter:prompt(String),prompt(String, List, String)andpromptForPassword(String)all exist as shown.Ran
mvn spotless:apply.