Document what the parent POM actually configures - #438
Merged
Conversation
The README was a badge and a line saying the canonical repository is this one. The site page said the parent 'defines common plugins, reporting and release configuration' and then went straight into settings.xml for the release manager - so a project inheriting this POM had no way to learn what it inherits. Both now cover the baselines, the enforcer rules, Spotless and where it applies vs checks, reproducible builds, the reporting profile, and what a child project still has to override. Corrects the release description. maven-release-plugin runs with releaseProfiles=plexus-release, which enables Njord, configured with autoPublish and publishingType=automatic - so the deployment publishes without a manual step in the Central Portal UI. The page implied otherwise by documenting only the token setup. Also warns that Spotless formats **/*.md and that parent 25 does not exclude src/site/markdown, which destroys Doxia front matter. Adds Plexus Build API, Sec Dispatcher and Testing to the Plexus Projects menu; all three were missing. Verified the site builds and all 17 entries resolve. Fixes the 'vie the Central Portal' typo. 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.
A project inheriting this POM currently has no way to find out what it inherits. The README is a badge plus "The current master is now at …", and the site page says the parent "defines common plugins, reporting and release configuration" before jumping straight into
settings.xmlfor the release manager. Everything in between — the thing most readers actually want — is missing.What's documented now
javaVersion, Maven 3.6.3 (3.9.0 when releasing), UTF-8, and thatmaven.compiler.procisnoneenforceBytecodeVersionrule — worth calling out, because rejecting a dependency whose bytecode is newer than your compiler target is the rule that surprises peoplespotless.actionisapplyunder theformatprofile (!env.CI) andcheckunderformat-check(env.CI). So a local build silently rewrites your sources and CI fails instead. That asymmetry was documented nowhere.reportingprofile, and the fact that building a site without-Preportingproduces one with no JavadocdistributionManagement/site, sincemaven-site-pluginruns withskipDeployand publishing goes throughmaven-scm-publish-pluginA correction to the release description
The site page documented the Central Portal token and stopped there, which implies a manual publish step. It isn't one.
maven-release-pluginis configured with<goals>deploy</goals>and<releaseProfiles>plexus-release</releaseProfiles>. That profile setsnjord.enabled=true, and Njord is registered as a build extension withautoPublish=trueandpublishingType=automatic. Sorelease:performpublishes to Central without anyone touching the Portal UI.I had this wrong too — the
RELEASING.mdin codehaus-plexus/.github#60 says to publish the staged deployment manually. I'm fixing that there.The Spotless/Markdown warning
Added, because it cost me three destroyed pages during codehaus-plexus/plexus-classworlds#149. Spotless formats
**/*.md; flexmark rewrites the fence closing a YAML front matter block into a setext underline and the page loses its title and author — or empties entirely.masterhere (26-SNAPSHOT) already excludes**/src/site/markdown/**, so this branch needs no code change. Released parent 25 does not, so anyone on 25 keeping site sources in Markdown has to add the exclusion themselves. That's now stated on the page rather than being folklore.Worth noting this is another argument for cutting 26 reasonably soon.
Menu
Added Plexus Build API, Plexus Sec Dispatcher and Plexus Testing to the
Plexus Projectsmenu — all three were missing. It's now all 17 projects, which makes this the most complete cross-navigation we have anywhere.Verified
Site builds; all 17 menu entries render and resolve (checked the three new ones return 200). Also fixes "publishing vie the Central Portal".
The
<version>in the README's parent snippet is25— the current release. Same staleness tradeoff as the other README PRs; happy to drop it for a badge reference if that's the preference.