Merge pull request #28 from dchenbec/shaded-jar

Add shaded JAR configuration for Maven

Author: dchenbec

.gitignore

@@ -1 +1,2 @@
 /target/
+/dependency-reduced-pom.xml

README.md

@@ -60,7 +60,11 @@ Set the Region explicitly in your `advanced.auth-provider.class` configuration (
 
 ## Add the Authentication Plugin to the Application
 
-The authentication plugin supports version 4.x of the DataStax Java Driver for Cassandra. If you’re using Apache Maven, or a build system that can use Maven dependencies, add the following dependencies to your `pom.xml` file.
+The authentication plugin supports version 4.x of the DataStax Java Driver for Cassandra.
+
+### With Maven/Ivy
+
+If you’re using Apache Maven, or a build system that can use Maven dependencies, add the following dependencies to your `pom.xml` file.
 
 ``` xml
 <dependency>
@@ -70,6 +74,12 @@ The authentication plugin supports version 4.x of the DataStax Java Driver for C
 </dependency>
 ```
 
+### Download the Shaded JAR
+
+If you just need the JAR to use with a third party tool, please use the shaded JAR (includes the SDK and other
+dependencies) located in the [releases](https://github.com/aws/aws-sigv4-auth-cassandra-java-driver-plugin/releases)
+section on GitHub.
+
 ## How to use the Authentication Plugin
 
 When using the open-source DataStax Java driver, the connection to your Amazon Keyspaces endpoint is represented by the `CqlSession` class. To create the `CqlSession`, you can either configure it programmatically using the `CqlSessionBuilder` class (accessed via `CqlSession.builder()`) or with the configuration file.

pom.xml

@@ -177,6 +177,69 @@
  </execution>
  </executions>
  </plugin>
+ <plugin>
+ <groupId>org.jacoco</groupId>
+ <artifactId>jacoco-maven-plugin</artifactId>
+ <version>0.8.7</version>
+ <executions>
+ <execution>
+ <id>default-prepare-agent</id>
+ <goals>
+ <goal>prepare-agent</goal>
+ </goals>
+ </execution>
+ <execution>
+ <id>default-report</id>
+ <phase>prepare-package</phase>
+ <goals>
+ <goal>report</goal>
+ </goals>
+ </execution>
+ <execution>
+ <id>default-check</id>
+ <goals>
+ <goal>check</goal>
+ </goals>
+ <configuration>
+ <rules>
+ <rule>
+ <element>BUNDLE</element>
+ <limits>
+ <limit>
+ <counter>COMPLEXITY</counter>
+ <value>COVEREDRATIO</value>
+ <minimum>0.60</minimum>
+ </limit>
+ </limits>
+ </rule>
+ </rules>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-shade-plugin</artifactId>
+ <version>3.2.4</version>
+ <configuration>
+ <shadedArtifactAttached>true</shadedArtifactAttached>
+ <useDependencyReducedPomInJar>true</useDependencyReducedPomInJar>
+ <artifactSet>
+ <!-- Generally, consumers of the shaded JAR
+ will already have the driver if they want
+ the plugin -->
+ <excludes>com.datastax.oss</excludes>
+ </artifactSet>
+ </configuration>
+ <executions>
+ <execution>
+ <phase>package</phase>
+ <goals>
+ <goal>shade</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
  </plugins>
  </build>