Skip to content

Commit

Permalink
Merge pull request #361 from awslabs/update_readme_and_pom
Browse files Browse the repository at this point in the history
Update release process and point README to a working release
  • Loading branch information
twollnik authored May 3, 2021
2 parents db63229 + 2065c5a commit 7bbb7fa
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 84 deletions.
17 changes: 1 addition & 16 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,17 +1,2 @@
# mvn profiles for the different supported
# Spark and Scala versions. Uncomment
# the one that you want to use. You can also
# override the profile on the command line:
# `make MVN_PROFILE=spark-2.4-scala-2.11 build`
MVN_PROFILE := spark-3.0-scala-2.12
# MVN_PROFILE := spark-2.4-scala-2.11
# MVN_PROFILE := spark-2.3-scala-2.11
# MVN_PROFILE := spark-2.2-scala-2.11

# Build the project for specific Spark and
# Scala versions. You can change the profile
# variable to use a different Scala or Spark
# version (see list above).
# If you need more log ouput remove the -q flag.
build:
mvn clean install -q -P $(MVN_PROFILE)
mvn clean install
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@ Python users may also be interested in PyDeequ, a Python interface for Deequ. Yo

## Requirements and Installation

__Deequ__ depends on Java 8. We provide releases compatible with Apache Spark versions 2.2.x to 2.4.x and 3.0.x.
__Deequ__ depends on Java 8. We provide releases compatible with Apache Spark versions 2.2.x to 3.0.x. The Spark 2.2.x and 2.3.x releases depend on Scala 2.11 and the Spark 2.4.x and 3.0.x releases depend on Scala 2.12.

Available via [maven central](http://mvnrepository.com/artifact/com.amazon.deequ/deequ).

Choose the latest release that matches your Scala and Spark versions from the [available versions](https://repo1.maven.org/maven2/com/amazon/deequ/deequ/). Add the release as a dependency to your project. For example:
Choose the latest release that matches your Spark version from the [available versions](https://repo1.maven.org/maven2/com/amazon/deequ/deequ/). Add the release as a dependency to your project. For example for spark 3.0.x:
__Maven__
```
<dependency>
<groupId>com.amazon.deequ</groupId>
<artifactId>deequ</artifactId>
<version>1.1.0_spark-3.0-scala-2.12</version>
<version>1.2.2-spark-3.0</version>
</dependency>
```
__sbt__
```
libraryDependencies += "com.amazon.deequ" % "deequ" % "1.1.0_spark-3.0-scala-2.12"
libraryDependencies += "com.amazon.deequ" % "deequ" % "1.2.2-spark-3.0"
```

## Example
Expand Down
84 changes: 20 additions & 64 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,23 @@
<modelVersion>4.0.0</modelVersion>

<groupId>com.amazon.deequ</groupId>
<artifactId>deequ${artifact.scala.version}${artifact.spark.version}</artifactId>
<version>1.1.0-SNAPSHOT</version>
<artifactId>deequ</artifactId>
<version>1.2.2-SNAPSHOT</version>

<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<encoding>UTF-8</encoding>

<!-- Scala (select 2.11 or 2.12) -->
<scala.major.version>2.12</scala.major.version>
<scala.version>${scala.major.version}.10</scala.version>
<artifact.scala.version>${scala.major.version}</artifact.scala.version>
<scala-maven-plugin.version>4.4.0</scala-maven-plugin.version>

<!-- Spark (select 2.2.3, 2.3.4, 2.4.7, or 3.0.1) -->
<spark.version>2.4.7</spark.version>
</properties>

<name>deequ</name>
<description>Deequ is a library built on top of Apache Spark for defining "unit tests for data",
Expand Down Expand Up @@ -54,28 +69,6 @@
<url>https://github.com/awslabs/deequ</url>
</scm>

<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<encoding>UTF-8</encoding>

<!-- Scala -->
<scala.major.version>${scala-211.major.version}</scala.major.version>
<scala.version>${scala.major.version}.10</scala.version>
<scala-211.major.version>2.11</scala-211.major.version>
<scala-212.major.version>2.12</scala-212.major.version>
<artifact.scala.version></artifact.scala.version>
<scala-maven-plugin.version>4.4.0</scala-maven-plugin.version>

<!-- Spark -->
<spark.version>${spark-24.version}</spark.version>
<spark-22.version>2.2.2</spark-22.version>
<spark-23.version>2.3.2</spark-23.version>
<spark-24.version>2.4.2</spark-24.version>
<spark-30.version>3.0.0</spark-30.version>
<artifact.spark.version></artifact.spark.version>
</properties>

<dependencies>
<dependency>
<groupId>org.scala-lang</groupId>
Expand Down Expand Up @@ -244,6 +237,9 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.2.0</version>
<configuration>
<finalName>${project.artifactId}_${scala.major.version}-${project.version}</finalName>
</configuration>
<executions>
<execution>
<goals>
Expand Down Expand Up @@ -403,46 +399,6 @@
</plugins>
</build>
</profile>
<profile>
<id>spark-2.2-scala-2.11</id>
<properties>
<spark.version>${spark-22.version}</spark.version>
<scala.major.version>${scala-211.major.version}</scala.major.version>
<scala.version>${scala.major.version}.10</scala.version>
<artifact.scala.version>_scala-${scala.major.version}</artifact.scala.version>
<artifact.spark.version>_spark-${spark.version}</artifact.spark.version>
</properties>
</profile>
<profile>
<id>spark-2.3-scala-2.11</id>
<properties>
<spark.version>${spark-23.version}</spark.version>
<scala.major.version>${scala-211.major.version}</scala.major.version>
<scala.version>${scala.major.version}.10</scala.version>
<artifact.scala.version>_scala-${scala.major.version}</artifact.scala.version>
<artifact.spark.version>_spark-${spark.version}</artifact.spark.version>
</properties>
</profile>
<profile>
<id>spark-2.4-scala-2.11</id>
<properties>
<spark.version>${spark-24.version}</spark.version>
<scala.major.version>${scala-211.major.version}</scala.major.version>
<scala.version>${scala.major.version}.10</scala.version>
<artifact.scala.version>_scala-${scala.major.version}</artifact.scala.version>
<artifact.spark.version>_spark-${spark.version}</artifact.spark.version>
</properties>
</profile>
<profile>
<id>spark-3.0-scala-2.12</id>
<properties>
<spark.version>${spark-30.version}</spark.version>
<scala.major.version>${scala-212.major.version}</scala.major.version>
<scala.version>${scala.major.version}.10</scala.version>
<artifact.scala.version>_scala-${scala.major.version}</artifact.scala.version>
<artifact.spark.version>_spark-${spark.version}</artifact.spark.version>
</properties>
</profile>
</profiles>

</project>

0 comments on commit 7bbb7fa

Please sign in to comment.