Merge pull request #100 from boschglobal/feature-83

test: Add Github Action to test SDK:main -> Databroker:master

.github/workflows/daily_integration_main-master.yaml

@@ -0,0 +1,24 @@
+name: SDK:main <-> Databroker:master
+
+on:
+  schedule:
+      - cron: "0 0 * * *"
+
+jobs:
+  integration-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: main
+
+      - name: Setup Project
+        uses: ./.github/actions/setup-project
+
+      - name: Run Tests
+        uses: ./.github/actions/run-tests
+        with:
+          upload-test-reports: true
+          databroker-version: master
+          kotest-tag: "Integration & DefaultDatabroker"

README.md

@@ -1,11 +1,12 @@
 # kuksa-sdk-android
 
-This is an Android SDK for the [KUKSA Vehicle Abstraction Layer](https://github.com/eclipse/kuksa.val).
-
-
 [![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Gitter](https://img.shields.io/gitter/room/kuksa-val/community)](https://gitter.im/kuksa-val/community)
 
+![SDK:main <-> Databroker:master](https://github.com/eclipse-kuksa/kuksa-android-sdk/actions/workflows/daily_integration_main-master.yaml/badge.svg)
+
+This is an Android SDK for the [KUKSA Vehicle Abstraction Layer](https://github.com/eclipse/kuksa.val).
+
 ## Overview
 
 The KUKSA Android SDK allows you to interact with [VSS data](https://covesa.github.io/vehicle_signal_specification/) 

docs/CONTRIBUTING.md

@@ -76,3 +76,38 @@ Used for detecting static code quality issues. It is recommended to install the
 #### [ktlint](https://pinterest.github.io/ktlint)
 
 Used for detecting static code style issues. 
+
+### Fail-Early-Builds
+
+We have multiple Fail-Early-Builds which run different versions of the KUKSA Android SDK against the KUKSA Databroker. 
+Our goal is to have an early indication which allows us more easily to find breaking or behavioral changes when running our SDK on a specific version of the Databroker. 
+
+When one of these builds fail a short validity check should be done:
+- Were the correct versions of the SDK and Databroker used? 
+- Is it a sporadically failing test? Does a re-run fixes it? 
+- Is apparent if the issue is inside the SDK (e.g. wrongly written test, bug) or inside the Databroker (e.g. behavioral change, bug)?
+
+Using different versions of the SDK and Databroker give different indications with varying importance. See the following list:
+
+**SDK:latestRelease -> Databroker:latestRelease**
+This means that issues exist between the latest released version of the SDK and the latest released version of the Databroker.
+
+If this build fails it should be considered as a potential bigger issue  
+=> A hotfix or new release needs to be done
+
+**SDK:latestRelease -> Databroker:master**
+This means, that the latest released version of the SDK is not compatible with the currently developed version of the Databroker.
+
+If this build fails it should be considered as a warning
+=> Required fixes should be part of the next SDK release
+
+**SDK:main -> Databroker:master**
+
+![SDK:main <-> Databroker:master](https://github.com/eclipse-kuksa/kuksa-android-sdk/actions/workflows/daily_integration_main-master.yaml/badge.svg)
+
+This means both the SDK and Databroker are running in a kind of "bleeding edge" state in their currently developed version.
+
+If this build fails, it should be considered as a warning. 
+=> It is okay for the pipeline to fail for a short period of time. Longer periods should be avoided.
+=> No explicit release / hotfix required, both components should be compatible before a release
+