#183: Updated user guide to include latest changes (#184)

Fixes #183 --------- Co-authored-by: Christoph Pirkl <[email protected]>
exasol · Jul 13, 2023 · e87ba8b · e87ba8b
1 parent 39f5b00
commit e87ba8b
Show file tree

Hide file tree

Showing 17 changed files with 240 additions and 291 deletions.
diff --git a/.github/workflows/ci-build.yml b/.github/workflows/ci-build.yml
@@ -18,7 +18,7 @@ jobs:
       fail-fast: false
       matrix:
         exasol-docker-version: [ 8.18.1 ]
-        profile: [ '-Pspark3.4', '-Pspark3.3', '-Pspark3.3-scala2.12' ]
+        profile: [ '-Pspark3.4', '-Pspark3.4-scala2.12', '-Pspark3.3', '-Pspark3.3-scala2.12' ]
     steps:
       - name: Checkout the repository
         uses: actions/checkout@v3

diff --git a/.github/workflows/release_droid_prepare_original_checksum.yml b/.github/workflows/release_droid_prepare_original_checksum.yml
@@ -6,10 +6,6 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        profile: [ '-Pspark3.4', '-Pspark3.3', '-Pspark3.3-scala2.12' ]
     steps:
       - name: Checkout the repository
         uses: actions/checkout@v3
@@ -24,7 +20,7 @@ jobs:
       - name: Enable testcontainer reuse
         run: echo 'testcontainers.reuse.enable=true' > "$HOME/.testcontainers.properties"
       - name: Run tests and build with Maven
-        run: mvn --batch-mode clean verify ${{ matrix.profile }}
+        run: mvn --batch-mode clean verify
       - name: Prepare checksum
         run: find */target -maxdepth 1 -name *.jar -exec sha256sum "{}" + > original_checksum
       - name: Upload checksum to the artifactory

diff --git a/.github/workflows/release_droid_print_quick_checksum.yml b/.github/workflows/release_droid_print_quick_checksum.yml
@@ -6,10 +6,6 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        profile: [ '-Pspark3.4', '-Pspark3.3', '-Pspark3.3-scala2.12' ]
     steps:
       - name: Checkout the repository
         uses: actions/checkout@v3
@@ -22,6 +18,6 @@ jobs:
           java-version: 11
           cache: 'maven'
       - name: Build with Maven skipping tests
-        run: mvn --batch-mode clean verify ${{ matrix.profile }} -DskipTests
+        run: mvn --batch-mode clean verify -DskipTests
       - name: Print checksum
         run: echo 'checksum_start==';find */target -maxdepth 1 -name *.jar -exec sha256sum "{}" + | xargs;echo '==checksum_end'
diff --git a/.github/workflows/release_droid_release_on_maven_central.yml b/.github/workflows/release_droid_release_on_maven_central.yml
@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        profile: [ '-Pspark3.4', '-Pspark3.3', '-Pspark3.3-scala2.12' ]
+        profile: [ '-Pspark3.4', '-Pspark3.4-scala2.12', '-Pspark3.3', '-Pspark3.3-scala2.12' ]
     steps:
       - name: Checkout the repository
         uses: actions/checkout@v3

diff --git a/.github/workflows/release_droid_upload_github_release_assets.yml b/.github/workflows/release_droid_upload_github_release_assets.yml
@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        profile: [ '-Pspark3.4', '-Pspark3.3', '-Pspark3.3-scala2.12' ]
+        profile: [ '-Pspark3.4', '-Pspark3.4-scala2.12', '-Pspark3.3', '-Pspark3.3-scala2.12' ]
     steps:
       - name: Checkout the repository
         uses: actions/checkout@v3

diff --git a/.project-keeper.yml b/.project-keeper.yml
@@ -25,8 +25,6 @@ excludes:
   - regex: "(?s)E-PK-CORE-62: The project's README.md does not contain a valid badges block. Please add or replace the following badges:.*"
   - "E-PK-CORE-18: Outdated content: '.github/workflows/ci-build-next-java.yml'"
   - "E-PK-CORE-18: Outdated content: '.github/workflows/ci-build.yml'"
-  - "E-PK-CORE-18: Outdated content: '.github/workflows/release_droid_prepare_original_checksum.yml'"
-  - "E-PK-CORE-18: Outdated content: '.github/workflows/release_droid_print_quick_checksum.yml'"
   - "E-PK-CORE-18: Outdated content: '.github/workflows/release_droid_upload_github_release_assets.yml'"
   - "E-PK-CORE-18: Outdated content: '.github/workflows/release_droid_release_on_maven_central.yml'"
   - "E-PK-CORE-18: Outdated content: '.settings/org.eclipse.jdt.core.prefs'"

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Spark Exasol Connector
 
 [![Build Status](https://github.com/exasol/spark-connector/actions/workflows/ci-build.yml/badge.svg)](https://github.com/exasol/spark-connector/actions/workflows/ci-build.yml)
-[![Maven Central – The Spark Exasol Connector](https://img.shields.io/maven-central/v/com.exasol/spark-connector)](https://central.sonatype.com/artifact/com.exasol/spark-connector_2.13/1.3.0-spark-3.3.2/versions)
+[![Maven Central – The Spark Exasol Connector](https://img.shields.io/maven-central/v/com.exasol/spark-connector)](https://mvnrepository.com/artifact/com.exasol/spark-connector)
 
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Aspark-connector&metric=alert_status)](https://sonarcloud.io/dashboard?id=com.exasol%3Aspark-connector)
 

diff --git a/dependencies.md b/dependencies.md
diff --git a/doc/changes/changes_1.5.0.md b/doc/changes/changes_1.5.0.md
@@ -27,6 +27,7 @@ Code name:
 * #164: Validated that write directory is empty
 * #171: Refactored artifact packaging and releasing for module setup
 * #174: Refactored Github `.github/workflow/` action files
+* #183: Updated user guide and prepared for release
 
 ## Dependency Updates
 
@@ -106,8 +107,9 @@ Code name:
 #### Compile Dependency Updates
 
 * Added `com.exasol:spark-connector-common-java:1.1.1`
-* Added `org.apache.hadoop:hadoop-aws:3.3.6`
+* Added `org.apache.hadoop:hadoop-aws:3.3.4`
 * Added `org.scala-lang:scala-library:2.13.11`
+* Added `org.wildfly.openssl:wildfly-openssl:2.2.5.Final`
 * Added `software.amazon.awssdk:s3:2.20.100`
 
 #### Test Dependency Updates

diff --git a/doc/images/databricks-deployment.png b/doc/images/databricks-deployment.png