Merge pull request #1 from Dannyj1/sonarcloud

SonarCloud GitHub Action

.github/workflows/build.yml

@@ -0,0 +1,37 @@
+name: SonarCloud
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  build:
+    name: Build and analyze
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: 'zulu' # Alternative distribution options are available
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: Cache Gradle packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.gradle/caches
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
+          restore-keys: ${{ runner.os }}-gradle
+      - name: Build and analyze
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: ./gradlew build sonar --info

README.md

@@ -22,6 +22,10 @@ Mistral-java-client is built against version 0.0.1 of the [Mistral AI API](https
 - [List Available Models](https://docs.mistral.ai/api/#operation/listModels)
 - "Create Embeddings" to be implemented later
 
+# Requirements
+- Java 17 or higher
+- A Mistral AI API Key (see the [Mistral documentation](https://docs.mistral.ai/#api-access) for more details on API access)
+
 # Installation
 
 ## Gradle

build.gradle

@@ -1,6 +1,7 @@
 plugins {
     id 'java'
     id 'maven-publish'
+    id "org.sonarqube" version "4.4.1.3373"
 }
 
 group = 'nl.dannyj'
@@ -27,7 +28,7 @@ dependencies {
 }
 
 java {
-    sourceCompatibility = '11'
+    sourceCompatibility = '17'
 }
 
 publishing {
@@ -40,4 +41,12 @@ publishing {
 
 test {
     useJUnitPlatform()
+}
+
+sonar {
+    properties {
+        property "sonar.projectKey", "Dannyj1_mistral-java-client"
+        property "sonar.organization", "danny1"
+        property "sonar.host.url", "https://sonarcloud.io"
+    }
 }