Skip to content

Commit 3c70d08

Browse files
authored
Update docs to clarify shading approach (#3974)
Make the docs section about our shading approach and motivation more up-to-date and less confusing (no JAX-RS/Jersey anymore, mention docker-java-api, etc)
1 parent f3ffed6 commit 3c70d08

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,9 @@ testImplementation('org.testcontainers:mysql') //no version specified
8686
[JitPack](jitpack_dependencies.md) builds are available for pre-release versions.
8787

8888
!!! warning "Shaded dependencies"
89-
Testcontainers uses the docker-java client library, which in turn depends on JAX-RS, Jersey and Jackson libraries.
90-
These libraries in particular seem to be especially prone to conflicts with test code/application under test code.
89+
Testcontainers depends on other libraries (like docker-java) for it to work.
90+
Some of them (JUnit, docker-java-{api,transport} and its transitive dependencies, JNA, visible-assertions and others) are part of our public API.
91+
But there are also "private", implementation detail dependencies (e.g. docker-java-core, Guava, OkHttp, etc etc) that are not exposed to public API but prone to conflicts with test code/application under test code.
9192
As such, **these libraries are 'shaded' into the core testcontainers JAR** and relocated under `org.testcontainers.shaded` to prevent class conflicts.
9293

9394
## Sponsors

0 commit comments

Comments
 (0)