JAVA-1544: Check API compatibility with Revapi

olim7t · olim7t · commit 0df59acbd263 · 2018-07-23T09:55:04.000-07:00
diff --git a/changelog/README.md b/changelog/README.md
@@ -4,6 +4,7 @@
 
 ### 4.0.0-beta2 (in progress)
 
+- [improvement] JAVA-1544: Check API compatibility with Revapi
 
 ### 4.0.0-beta1
 
diff --git a/core-shaded/pom.xml b/core-shaded/pom.xml
@@ -121,6 +121,13 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.revapi</groupId>
+        <artifactId>revapi-maven-plugin</artifactId>
+        <configuration>
+          <skip>true</skip>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
 </project>
diff --git a/core/revapi.json b/core/revapi.json
@@ -0,0 +1,16 @@
+// Configures Revapi (https://revapi.org/getting-started.html) to check API compatibility between
+// successive driver versions.
+{
+  "revapi": {
+    "java": {
+      "filter": {
+        "packages": {
+          "regex": true,
+          "include": [
+            "com\\.datastax\\.oss\\.driver\\.api\\..*"
+          ]
+        }
+      }
+    }
+  }
+}
diff --git a/distribution/pom.xml b/distribution/pom.xml
@@ -90,6 +90,13 @@
           <skip>true</skip>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.revapi</groupId>
+        <artifactId>revapi-maven-plugin</artifactId>
+        <configuration>
+          <skip>true</skip>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
 
diff --git a/integration-tests/pom.xml b/integration-tests/pom.xml
@@ -216,6 +216,13 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.revapi</groupId>
+        <artifactId>revapi-maven-plugin</artifactId>
+        <configuration>
+          <skip>true</skip>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
 </project>
diff --git a/pom.xml b/pom.xml
@@ -289,6 +289,18 @@
           <artifactId>maven-bundle-plugin</artifactId>
           <version>3.5.0</version>
         </plugin>
+        <plugin>
+          <groupId>org.revapi</groupId>
+          <artifactId>revapi-maven-plugin</artifactId>
+          <version>0.10.4</version>
+          <dependencies>
+            <dependency>
+              <groupId>org.revapi</groupId>
+              <artifactId>revapi-java</artifactId>
+              <version>0.18.0</version>
+            </dependency>
+          </dependencies>
+        </plugin>
       </plugins>
     </pluginManagement>
     <plugins>
@@ -542,6 +554,23 @@ limitations under the License.]]>
           </supportedProjectTypes>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.revapi</groupId>
+        <artifactId>revapi-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <goals>
+              <goal>check</goal>
+            </goals>
+            <configuration>
+              <analysisConfigurationFiles>
+                <!-- Present at the root of each module that doesn't skip this goal -->
+                <analysisConfigurationFile>revapi.json</analysisConfigurationFile>
+              </analysisConfigurationFiles>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
   <profiles>
diff --git a/query-builder/revapi.json b/query-builder/revapi.json
@@ -0,0 +1,16 @@
+// Configures Revapi (https://revapi.org/getting-started.html) to check API compatibility between
+// successive driver versions.
+{
+  "revapi": {
+    "java": {
+      "filter": {
+        "packages": {
+          "regex": true,
+          "include": [
+            "com\\.datastax\\.oss\\.driver\\.api\\..*"
+          ]
+        }
+      }
+    }
+  }
+}
diff --git a/test-infra/revapi.json b/test-infra/revapi.json
@@ -0,0 +1,16 @@
+// Configures Revapi (https://revapi.org/getting-started.html) to check API compatibility between
+// successive driver versions.
+{
+  "revapi": {
+    "java": {
+      "filter": {
+        "packages": {
+          "regex": true,
+          "include": [
+            "com\\.datastax\\.oss\\.driver\\.api\\..*"
+          ]
+        }
+      }
+    }
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`### 4.0.0-beta2 (in progress)`
`6`	`6`
	`7`	`+- [improvement] JAVA-1544: Check API compatibility with Revapi`
`7`	`8`
`8`	`9`	`### 4.0.0-beta1`
`9`	`10`