Repository navigation
Document that excluded dependencies are not added to shadow configuration - #2344
Merged
Merged
Conversation
…tion Explain why dependencies excluded by the ShadowJar dependency filter are not exposed to consumers, and how to declare them in the `shadow` configuration explicitly.
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation and test assertions match existing behavior, with no unresolved findings or production-code changes.
No open issues 🎉
What changed in this PR
This PR addresses #265 by documenting why excluded dependencies are not automatically added to the shadow configuration and how to declare them explicitly for consumers. It documents existing behavior without changing production code.
Changes:
- Adds Kotlin and Groovy examples for keeping a transitive dependency external.
- Links publishing guidance to the new excluded-dependency documentation.
- Adds a functional test covering JAR contents, manifest classpath, POM dependencies, and Gradle Module Metadata.
| File | Description |
|---|---|
src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/PublishingTest.kt |
Tests publishing with an explicitly declared external dependency. |
docs/publishing/README.md |
Links to guidance for declaring excluded dependencies. |
docs/configuration/dependencies/README.md |
Explains exclusion behavior and provides explicit shadow dependency examples. |
Review effort: Balanced
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.
Closes #265.