Repository navigation
Conversation
Extend the existing formatter and CI check to Maven POM files so contributors share one formatting baseline instead of IDE-specific output. Normalize the reactor POMs and document the formatting policy without changing dependencies or enabling dependency and plugin list sorting. Fixes apolloconfig#5701 Assisted-by: Claude Opus 5 (1M context)
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation |
|---|---|---|
| Description Check |  |
Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | |
The title "chore: standardize POM formatting with Spotless SortPom" matches the main change. The PR adds SortPom formatting for Maven POM files to the root Spotless configuration and reformats the roo… |
| Linked Issues check | |
Issue #5701 is addressed. The root pom.xml adds the Spotless POM formatter with SortPom and preserves the existing Java formatter. The PR formats the root and module POMs with the requested UTF-8, t… |
| Out of Scope Changes check | |
The changes stay within issue #5701. The diff contains the Spotless POM configuration, formatting changes to Maven POM files, contributor documentation, and a related CHANGES.md entry. It does not c… |
| Docstring Coverage | |
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0… |
Full details: Title check
-
Explanation
The title "chore: standardize POM formatting with Spotless SortPom" matches the main change. The PR adds SortPom formatting for Maven POM files to the root Spotless configuration and reformats the root and module POMs. The title is specific, short, and free of file lists or vague terms. The changeset also includes a CONTRIBUTING.md update and a CHANGES.md entry, which the title does not mention, but those are supporting documentation.
Full details: Linked Issues check
-
Explanation
Issue
#5701is addressed. The rootpom.xmladds the Spotless POM formatter with SortPom and preserves the existing Java formatter. The PR formats the root and module POMs with the requested UTF-8, two-space, self-closing-element policy and preserves repeated-list order.CONTRIBUTING.mddocumentsspotless:applyandspotless:check, including CI coverage. The reported reactor formatting check, idempotence check,clean test, and diff check passed.
Full details: Out of Scope Changes check
-
Explanation
The changes stay within issue
#5701. The diff contains the Spotless POM configuration, formatting changes to Maven POM files, contributor documentation, and a relatedCHANGES.mdentry. It does not change Java formatting, arbitrary XML resources, dependency versions, plugin values, or IDE XML settings.
Full details: Docstring Coverage
-
Explanation
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (16 skipped: 16 unsupported.)
✨ Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
Record the SortPom formatting change with its upstream PR URL. Assisted-by: Claude Opus 5 (1M context)
What's the purpose of this PR
Extend Apollo's existing Spotless formatting and CI check to Maven POM files, providing a shared baseline instead of IDE-specific indentation, wrapping, and element ordering.
Which issue(s) this PR fixes:
Fixes #5701
Brief changelog
<pom>formatter using SortPom to the root Spotless plugin configuration; each reactor module formats its ownpom.xmlthrough inheritance.recommended_2008_06element order, UTF-8, two-space indentation, and self-closing empty elements (expandEmptyElements=false).CONTRIBUTING.md. The existingmvn spotless:checkCI command now checks POMs as well; no separate workflow is needed.CHANGES.mdentry linking to this PR.The relevant formatting choices are compatible with the Google XML Style Guide, which permits two-space indentation and both empty-element forms and does not mandate a universal POM element order or fixed line width. IDE XML setting changes are out of scope; Spotless is the authoritative POM formatting baseline.
Test plan
Validated locally with JDK 17:
./mvnw -B spotless:apply spotless:check— all 14 reactor projects passed; no Java source changes../mvnw -B clean test— all reactor projects passed; 1,404 tests, 0 failures, 0 errors, 1 skipped.spotless:apply spotless:checkafter the clean build — passed and changed none of the 1,599 tracked files (SHA-256 comparison).master— configuration values and repeated-element order preserved; only the intended formatter block was added, with whitespace/comment formatting and structural POM element ordering changes.git diff --check— passed.Follow this checklist to help us incorporate your contribution quickly and easily:
mvn clean testto make sure this pull request doesn't break anything.mvn spotless:applyto format your code.CHANGESlog — added in a follow-up commit using this PR URL.🤖 Generated with Claude Code
Assisted-by: Claude Opus 5 (1M context)
Summary by CodeRabbit