Merge pull request #429 from weaviate/v6-shade-for-uber-jar

v6: include a shaded version of client6 in deployment bundle

Author: bevzzz

README.md

@@ -6,7 +6,7 @@ Official Weaviate Java Client.
 
 ## Usage
 
-To start using Weaviate Java Client add this dependency to `pom.xml`:
+To start using Weaviate Java Client add the dependency to `pom.xml`:
 
 ```xml
 
@@ -17,11 +17,17 @@ To start using Weaviate Java Client add this dependency to `pom.xml`:
 </dependency>
 ```
 
-### For applications on Java 9 or above
+### Uber JAR🫙
+
+If you're building a uber-JAR with something like `maven-assembly-plugin`, use a shaded version with classifier `all`.  
+This ensures that all dynamically-loaded dependecies of `io.grpc` are resolved correctly.
+
+
+### Gson and reflective access to internal JDK classes
 
 The client uses Google's [`gson`](https://github.com/google/gson) for JSON de-/serialization which does reflection on internal `java.lang` classes. This is _not allowed by default_ in Java 9 and above.
 
-To work around this, it's necessary to add this JVM commandline argument:
+To work around this, it's necessary to add this JVM command line argument:
 
 ```
 --add-opens=java.base/java.lang=ALL-UNNAMED

pom.xml

@@ -216,7 +216,6 @@
             <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.58.0:exe:${os.detected.classifier}</pluginArtifact>
             <outputDirectory>src/main/java</outputDirectory>
             <clearOutputDirectory>false</clearOutputDirectory>
-
           </configuration>
           <executions>
             <execution>
@@ -461,6 +460,28 @@
           <artifactId>maven-project-info-reports-plugin</artifactId>
           <version>3.1.1my</version>
         </plugin>
+
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-shade-plugin</artifactId>
+          <version>3.6.0</version>
+          <configuration>
+            <createDependencyReducedPom>false</createDependencyReducedPom>
+            <shadedArtifactAttached>true</shadedArtifactAttached>
+            <shadedClassifierName>all</shadedClassifierName>
+            <transformers>
+              <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
+            </transformers>
+          </configuration>
+          <executions>
+            <execution>
+              <phase>package</phase>
+              <goals>
+                <goal>shade</goal>
+              </goals>
+            </execution>
+          </executions>
+        </plugin>
       </plugins>
     </pluginManagement>
     <plugins>
@@ -480,6 +501,10 @@
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>build-helper-maven-plugin</artifactId>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-shade-plugin</artifactId>
+      </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>