Skip to content

[docs] Document shading pitfalls in the building guide - #4103

Open
Jackeyzhe wants to merge 1 commit into
apache:mainfrom
Jackeyzhe:docs-shaded-building-guide
Open

[docs] Document shading pitfalls in the building guide#4103
Jackeyzhe wants to merge 1 commit into
apache:mainfrom
Jackeyzhe:docs-shaded-building-guide

Conversation

@Jackeyzhe

Copy link
Copy Markdown
Contributor

Adds a short "Shaded dependencies" section to the building guide covering two
pitfalls we hit while fixing shaded-Jackson leaks into uber-jars (#3553 / #3884):

  1. The Maven Shade Plugin does not relocate Multi-Release JAR entries
    (META-INF/versions/**) — unshaded classes leak into the uber-jar unless the
    shade configuration adds an explicit exclusion filter for that path.
  2. combine.children="append" appends child filters to the parent's instead of
    replacing them, so a cross-module exclusion must live in the root pom.xml
    shade configuration to take effect everywhere.

Both are non-obvious and cost real debugging time; documenting them in the
building guide should help future contributors who touch the build.

Related: #3884, #4073

@Jackeyzhe
Jackeyzhe force-pushed the docs-shaded-building-guide branch from 7349968 to 8481643 Compare August 26, 2026 10:16
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