Add a shading guide to the site - #61
Merged
Merged
Conversation
Document that the Secure* entry points are designed as independent shade closures: per-entry-point shaded size estimates, the security trade-offs of dependency vs. shading vs. vendored recipes, and a maven-shade-plugin configuration that relocates commons-xml alone. Also make the ShadingFootprintTest report compute its percentages against the union of all entry-point closures, matching its "% of full library" header. Assisted-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MbfpcsKig16HfSe6jGhcvh
garydgregory
requested changes
Aug 30, 2026
garydgregory
left a comment
garydgregory
left a comment
Member
There was a problem hiding this comment.
I've moved documentation to the Javadoc side so it always matches the code. This can go there as well.
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
2 participants
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.
Adds a
shading.mdsite page documenting that theSecure*entry points are designed as independent shade closures:ShadingFootprintTest, scaled by the jar's overall compression ratio; measured on 1.0.0),throw on unsupported propertiesandnewDefaultInstance()as mitigations),maven-shade-pluginconfiguration that relocatescommons-xmlalone while leaving other dependencies external.Also fixes
ShadingFootprintTest.reportFootprint()to compute its percentages against the union of all entry-point closures, matching its "% of full library" header (previously it divided by the DOM closure only).The page follows the site conventions: semantic line breaks, ASF license header,
.htmlcross-links;site.xmlgains a "Shading" menu item. Verified withmvn test -Dtest=ShadingFootprintTest,mvn apache-rat:check, and a fullmvn siterender.🤖 Generated with Claude Code
https://claude.ai/code/session_01MbfpcsKig16HfSe6jGhcvh