Document the build lifecycle and troubleshooting#488
Open
ppkarwasz wants to merge 1 commit into
Open
Conversation
Add two Antora pages describing what the Logging Parent POM adds to the Maven build: - `build-lifecycle.adoc`: the checks, generated artifacts, and POM transformations bound to `./mvnw verify`; the opt-in profiles (build modifiers and commands); and what is inherited from the ASF Parent POM. - `troubleshooting.adoc`: recipes for the two checks that are hardest to diagnose, the BND baseline API-compatibility check and the `requireUpperBoundDeps` dependency-convergence check, using real captured error output. Wire both pages into the site navigation under a new "Build" group. Assisted-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Summary
Adds two Antora documentation pages that explain what the Logging Parent POM adds to a Maven build, addressing the long-standing gap that
features.adoconly lists bundled plugins.build-lifecycle.adoc: a phase-by-phase overview table plus sections on:META-INF/{LICENSE,NOTICE,DEPENDENCIES});${revision}resolution and BOM flattening);release,coverage,apache.snapshots) and commands (changelog-release,distribution,deploy).troubleshooting.adoc: debugging recipes for the two checks that are hardest to diagnose:MICRO/MINOR/MAJORfixes, and the rationale behind the package-versioning convention);requireUpperBoundDepsorder-independent dependency resolution check (how to read the error and whether to pin, bump, or unpin).Both troubleshooting recipes use real error output captured by reproducing the failures locally.
Both pages are wired into the site navigation under a new "Build" group.
Notes
site-lifecyclepage is intentionally deferred for a follow-up; its references were removed from this change.🤖 Generated with Claude Code