Rewrite README with usage, status and version guidance - #332
Merged
Conversation
Adds what the library is, the two current release lines, a dependency snippet, the Java baseline and documentation links. The substantial addition is upgrade guidance for 3.x to 4.x. The XML classes moved to plexus-xml in 4, and the first sign most people get is NoClassDefFoundError on Xpp3Dom. The README mentioned the split but did not say what to add to fix it, or how to choose between plexus-xml 3 and 4 - the latter needs Java 17 and only works under Maven 4. Also notes that 3.x is still released, from the plexus-utils-3.x branch, which was not documented anywhere. Part of codehaus-plexus/.github#58
CI runs spotless:check and the Markdown table was not in the format flexmark produces.
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
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 approved pilots (codehaus-plexus/plexus-archiver#438, codehaus-plexus/plexus-i18n#37).
This is the repo where the version guidance section earns its keep, so it's worth more than a mechanical pass.
The upgrade story wasn't written down
The old README said the XML classes had moved to
plexus-xml— but not what to do about it. In practice the first thing someone hits upgrading 3 → 4 isNoClassDefFoundErroronXpp3Dom, and nothing told them the fix. The README now gives the exact dependency to add, and, more importantly, how to choose:plexus-xml3.x — straight extraction, same classes and packages, works under Maven 3plexus-xml4.x — rebuilt on Maven 4'smaven-xml-api, needs Java 17, Maven 4 onlyPicking the wrong one of those is a bad afternoon, and we documented it nowhere.
It also records that
3.xis still an active release line (3.6.1 shipped from theplexus-utils-3.xbranch), which wasn't stated anywhere. Someone looking only atmasterwould reasonably conclude 3.x was dead.Status section
Says plainly that this is conservatively maintained, that it's on the classpath of nearly every Maven build, and that for new code the JDK equivalent is usually the better choice where one exists. That last point is honest rather than promotional, but it's what I'd tell someone who asked.
Corrections I made while writing this
Worth flagging, since I nearly shipped both:
3.xrequires Java 7. It doesn't — theplexus-utils-3.xbranch inherits parent POM 25, sojavaVersionis 8, same as4.x. The two lines don't differ by Java baseline at all, so I dropped that column rather than have the table imply they do.plexus-xml3.0.1 in the snippet. Central's latest 3.x is 3.0.2 (3.0.3 is tagged on GitHub but not synced). Checked againstmaven-metadata.xmlrather than the Central search index, which is stale — it was reporting plexus-archiver 4.10.0 while 4.12.0 was published.Removed
The "The current master is now at https://github.com/codehaus-plexus/plexus-utils" line — shown to a reader already on that page — and the site-publishing recipe, which contradicted this repo's own POM. The POM binds
scm-publishtosite-deployand comments "mono-module doesn't require site:stage", while the README told you to runsite site:stage scm-publish:publish-scm. That procedure now lives once in RELEASING.md (codehaus-plexus/.github#60).