Repository navigation
[infra] Add a dist and dependency review guide - #1022
Merged
Merged
Conversation
Fills the last planned row of the Change-Type Review Guides table in code_review.md with a focused guide for changes to what the project ships or bundles. The guide covers the failure modes the build does not report: a module absent from the hand-written list in dist/pom.xml, a NOTICE that no check validates, a bundled version chosen by dependency mediation, a shade filter that matches more than it was written for, and a licence header that passes a check keyed on the Apache License URL. Generated-by: Claude Code 2.1.233 (Claude Opus 5)
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.
Linked issue: #894
Purpose of change
code_review.md's Change-Type Review Guides table had one row left readingplanned. A reviewer facing a change to what the project ships fell back to the general passes, which ask the right question without saying what breaks in this area.This adds
review-guides/dist-dependency.mdand links that row, completing the set of four guides.The guide is organised around the failures the build does not report, rather than around the three sub-areas the table's Focus cell names, because the mechanisms cut across them. What it covers:
dist/pom.xmlcan compile, test, and release green while shipping none of its classes. The shipped set is a hand-written list of dependencies rather than anything derived from the reactor.providedortestchanges what ships, while moving betweencompileandruntimedoes not.The
dist registrationsub-area has no example row. No reviewer has raised a missing dist registration on any PR in this repository, merged or open, across the full inline-comment history. Rather than stretch a citation, that sub-area is covered by a checklist bullet and cited to nothing.Tests
No code changes, so verification was of the guide's claims and its published commands.
Every command in the Validation block was run as written, at two different substitutions of the
<version>placeholder../tools/check-license.shexits 0, and the new file needs no licence header becausetools/.rat-excludesalready coversreview-guides/*— confirmed with a control file rather than by reading the glob.The factual claims were verified against built artifacts rather than against the poms. The scope claim was measured across 177 artifacts on a built fat jar: compile and runtime dependencies are all present, provided and test dependencies all absent. The licence-header behaviour was established by running Apache RAT against deliberately degraded headers. The relative link was resolved by hand, since no markdown link checker runs anywhere in the repository.
API
No. Documentation only.
Documentation
doc-neededdoc-not-neededdoc-includedWas this patch authored or co-authored using generative AI tooling?
Generated-by: Claude Code 2.1.233 (Claude Opus 5)