Skip to content

Document the build lifecycle and troubleshooting#488

Open
ppkarwasz wants to merge 1 commit into
mainfrom
doc/build-lifecycle
Open

Document the build lifecycle and troubleshooting#488
ppkarwasz wants to merge 1 commit into
mainfrom
doc/build-lifecycle

Conversation

@ppkarwasz

Copy link
Copy Markdown
Member

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.adoc only lists bundled plugins.

  • build-lifecycle.adoc: a phase-by-phase overview table plus sections on:
    • the checks (Maven & Java version, order-independent dependency resolution, code style, changelog validation, Error Prone, SpotBugs + FindSecBugs, license validation, BND baseline), each tagged with its phase and origin (this POM vs. the ASF Parent POM);
    • the generated artifacts (OSGi manifest, JPMS descriptor, ServiceLoader descriptor, CycloneDX SBOM, and the inherited META-INF/{LICENSE,NOTICE,DEPENDENCIES});
    • the POM transformations (CI-friendly ${revision} resolution and BOM flattening);
    • the opt-in profiles: build modifiers (release, coverage, apache.snapshots) and commands (changelog-release, distribution, deploy).
  • troubleshooting.adoc: debugging recipes for the two checks that are hardest to diagnose:
    • the BND baseline API-compatibility check (how to read the delta report, the MICRO/MINOR/MAJOR fixes, and the rationale behind the package-versioning convention);
    • the requireUpperBoundDeps order-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

  • Website/docs only; no change to the released parent POM artifact, so no changelog entry is included.
  • A site-lifecycle page is intentionally deferred for a follow-up; its references were removed from this change.

🤖 Generated with Claude Code

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>
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.

1 participant