Merge pull request #528 from weaviate/v6-rebased

Upgrade main branch to v6

Author: bevzzz

.github/CODEOWNERS

@@ -1,4 +1,4 @@
-# Ci related folders
+# CI related resources
 /.github/ @weaviate/core
 decrypt_secret.sh @weaviate/core
 secrets.tar.gp @weaviate/core

.github/workflows/create-release.yaml

@@ -1,17 +1,22 @@
 name: Create Release
 on:
   push:
-    # run only on tags
     tags:
       - '**'
+  pull_request:
+    # Release a new SNAPSHOT version every time a PR is merged to v6.
+    types: [closed]
+    branches: ['v6']
 
 jobs:
   release:
     name: Deploy
-    if: startsWith(github.ref, 'refs/tags')
+    if: >
+      (github.event_name == 'push' && startsWith(github.ref, 'refs/tags'))
+      || (github.event_name == 'pull_request' && github.event.pull_request.merged == true)
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Unpack secrets
         env:
           GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
@@ -39,7 +44,7 @@ jobs:
           retention-days: 1
   gh-release:
     name: Create a GitHub Release
-    if: startsWith(github.ref, 'refs/tags')
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
     runs-on: ubuntu-latest
     needs: [ release ]
     steps:

.github/workflows/test.yaml

@@ -4,27 +4,118 @@ on:
     branches:
       - main
   pull_request:
+concurrency:
+  group: tests-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  IMG2VEC: cr.weaviate.io/semitechnologies/img2vec-pytorch:resnet50
+  MINIO: minio/minio
+  MODEL2VEC: cr.weaviate.io/semitechnologies/model2vec-inference:minishlab-potion-base-4M
+  DOCKER_IMAGES_TAR: docker-images.tar
 
 jobs:
-  tests:
-    name: Tests
+  docker-cache:
+    name: Cache shared Docker images
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - name: Login to Docker Hub
-      if: ${{ !github.event.pull_request.head.repo.fork }}
-      uses: docker/login-action@v2
-      with:
-        username: ${{secrets.DOCKER_USERNAME}}
-        password: ${{secrets.DOCKER_PASSWORD}}
-    - name: Run Build
-      run: mvn -DskipTests clean package
-    - name: Run Tests
-      env:
-        OKTA_DUMMY_CI_PW: ${{ secrets.OKTA_DUMMY_CI_PW }}
-        WCS_DUMMY_CI_PW: ${{ secrets.WCS_DUMMY_CI_PW }}
-        OKTA_CLIENT_SECRET: ${{ secrets.OKTA_CLIENT_SECRET }}
-        AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
-        OPENAI_APIKEY: ${{ secrets.OPENAI_APIKEY }}
-      run: |
-        mvn clean test
+      - name: Login to Docker Hub
+        if: ${{ !github.event.pull_request.head.repo.fork }}
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      - id: cache-check
+        uses: actions/cache/restore@v4
+        env:
+          DOCKER_CACHE_KEY: docker-images-${{ env.IMG2VEC }}-${{ env.MINIO }}-${{ env.MODEL2VEC }}
+        with:
+          path: ${{ env.DOCKER_IMAGES_TAR }}
+          key: ${{ env.DOCKER_CACHE_KEY }}
+          lookup-only: true # Only check if cache exists, don't download
+      - name: Free Disk Space (Ubuntu)
+        uses: jlumbroso/free-disk-space@v1.3.1
+        with:
+          tool-cache: false
+          android: true
+          dotnet: true
+          haskell: true
+          large-packages: true
+          docker-images: false
+          swap-storage: false
+      - name: Pull images
+        if: steps.cache-check.outputs.cache-hit != 'true'
+        run: |
+          docker pull $IMG2VEC
+          docker pull $MINIO
+          # docker pull $MODEL2VEC
+          docker save $IMG2VEC $MINIO -o $DOCKER_IMAGES_TAR
+      - name: Cache images
+        if: steps.cache-check.outputs.cache-hit != 'true'
+        uses: actions/cache/save@v4
+        env:
+          DOCKER_CACHE_KEY: docker-images-${{ env.IMG2VEC }}-${{ env.MINIO }}-${{ env.MODEL2VEC }}
+        with:
+          path: ${{ env.DOCKER_IMAGES_TAR }}
+          key: ${{ env.DOCKER_CACHE_KEY }}
+
+  maven-cache:
+    name: Cache Maven dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: "zulu"
+          java-version: "17"
+          cache: "maven"
+      - run: mvn dependency:go-offline
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    needs: [docker-cache, maven-cache]
+    strategy:
+      fail-fast: false
+      matrix:
+        WEAVIATE_VERSION: ["1.32.24", "1.33.11", "1.34.7", "1.35.2"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/cache/restore@v4
+        env:
+          DOCKER_CACHE_KEY: docker-images-${{ env.IMG2VEC }}-${{ env.MINIO }}-${{ env.MODEL2VEC }}
+        with:
+          path: ${{ env.DOCKER_IMAGES_TAR }}
+          key: ${{ env.DOCKER_CACHE_KEY }}
+      - name: Free Disk Space (Ubuntu)
+        uses: jlumbroso/free-disk-space@v1.3.1
+        with:
+          tool-cache: false
+          android: true
+          dotnet: true
+          haskell: true
+          large-packages: true
+          docker-images: false
+          swap-storage: false
+      - name: Load Docker images
+        run: |
+          if [ -f $DOCKER_IMAGES_TAR ]; then
+            docker load -i $DOCKER_IMAGES_TAR
+          fi
+      - uses: actions/setup-java@v4
+        name: Setup JDK
+        with:
+          distribution: "zulu"
+          java-version: "17"
+          cache: "maven"
+
+      - name: Run Tests (v${{ matrix.WEAVIATE_VERSION }})
+        env:
+          OKTA_DUMMY_CI_PW: ${{ secrets.OKTA_DUMMY_CI_PW }}
+          WCS_DUMMY_CI_PW: ${{ secrets.WCS_DUMMY_CI_PW }}
+          OKTA_CLIENT_SECRET: ${{ secrets.OKTA_CLIENT_SECRET }}
+          AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
+          OPENAI_APIKEY: ${{ secrets.OPENAI_APIKEY }}
+          WEAVIATE_VERSION: ${{ matrix.WEAVIATE_VERSION }}
+        run: mvn verify -Dgpg.skip

.gitignore

@@ -11,3 +11,5 @@
 target/
 # maven-lombok-plugin
 .factorypath
+# Surefire statistics for optimized execution time
+.surefire-*

CONTRIBUTE.md

@@ -2,7 +2,7 @@
 Contributing works pretty easy. You can do a pull request or you can commit if you are part of a Weaviate team.
 
 ### Code of Conduct
-Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. 
+Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
 
 
@@ -27,6 +27,22 @@ AKA: smart commits
 
 If you create a pull request without smart commits, the pull request will be [squashed into](https://blog.github.com/2016-04-01-squash-your-commits/) one git commit.
 
+### Updating dependencies
+
+It's a good practice to periodically check for possible dependency upgrades. Ideally, we should do it before every release.
+
+```sh
+mvn versions:display-property-updates
+```
+
+If appropriate, update dependency version with this command:
+
+```sh
+mvn versions:update-properties
+```
+
+Commit all version upgrades in a single commit, unless there's a good reason not to.
+
 ### Contributor License Agreement
 
 Contributions to Weaviate Java client must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of Weaviate Java client. Go to [this page](https://weaviate.io/service/contributor-license-agreement) to read the current agreement.