From 70033cd08a60e2aea8019e6bb8185a5869b456b5 Mon Sep 17 00:00:00 2001 From: Tomo Suzuki Date: Tue, 13 Feb 2024 14:43:35 -0500 Subject: [PATCH 1/3] docs: release note helps dependency conflicts resolution docs: release note helps dependency conflicts resolution --- TROUBLESHOOTING.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index 7c902839687e..d05e7a6755a2 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -200,9 +200,26 @@ There are different strategies to resolve conflicts, but you must understand the ... ``` +- The release note of the libraries-bom also shows the compatible dependency libraries. + For example, https://github.com/googleapis/java-cloud-bom/releases/tag/v26.31.0 shows + + > These client libraries are built with the following Java libraries: + > + > - Guava: 32.1.3-jre + > - Protobuf Java: 3.25.2 + > - Google Auth Library: 1.22.0 + > - Google API Client: 2.2.0 + > - gRPC: 1.61.0 + > - GAX: 2.41.0 + > - Google Cloud Core: 2.31.0 + + By examining the dependency graph of your project (`mvn dependency:tree -Dverbose` + or `gradle dependencies`), you may find some of the dependencies having unexpected + versions. They might cause dependency conflicts. + - If changing dependency versions causes other failures, consider [shading dependencies](https://maven.apache.org/plugins/maven-shade-plugin/) - that conflict with `google-cloud-java`. + that conflict with Google Cloud Java libraries. For example, to shade `guava` and `protobuf-java`: From b75c7905c510c112bad181a297188c064c571714 Mon Sep 17 00:00:00 2001 From: Tomo Suzuki Date: Tue, 13 Feb 2024 14:44:21 -0500 Subject: [PATCH 2/3] Update TROUBLESHOOTING.md --- TROUBLESHOOTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index d05e7a6755a2..b66f2e1e16ae 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -200,7 +200,7 @@ There are different strategies to resolve conflicts, but you must understand the ... ``` -- The release note of the libraries-bom also shows the compatible dependency libraries. +- The release note of the libraries-bom shows the compatible dependency libraries. For example, https://github.com/googleapis/java-cloud-bom/releases/tag/v26.31.0 shows > These client libraries are built with the following Java libraries: From 5a84f69da52f05efd102129334b563f78e958ed7 Mon Sep 17 00:00:00 2001 From: Tomo Suzuki Date: Tue, 13 Feb 2024 14:48:03 -0500 Subject: [PATCH 3/3] Update TROUBLESHOOTING.md --- TROUBLESHOOTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index b66f2e1e16ae..a07a9fe80e3c 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -213,9 +213,9 @@ There are different strategies to resolve conflicts, but you must understand the > - GAX: 2.41.0 > - Google Cloud Core: 2.31.0 - By examining the dependency graph of your project (`mvn dependency:tree -Dverbose` - or `gradle dependencies`), you may find some of the dependencies having unexpected - versions. They might cause dependency conflicts. + By examining the dependency graph of your project (`mvn dependency:tree -Dverbose`, + `gradle dependencies`, or `sbt dependencyTree`), you may find some of the dependencies + having unexpected versions. They might cause dependency conflicts. - If changing dependency versions causes other failures, consider [shading dependencies](https://maven.apache.org/plugins/maven-shade-plugin/)