Skip to content

Commit

Permalink
chore: Add Badges to Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wba2hi committed Mar 11, 2024
1 parent 8eeebab commit 04ef185
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/)
Expand Down
9 changes: 6 additions & 3 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Used for detecting static code quality issues. It is recommended to install the

Used for detecting static code style issues.

#### Fail-Early-Builds
### 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.
Expand All @@ -92,7 +92,7 @@ Using different versions of SDK and Databroker give different indications with v
**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
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**
Expand All @@ -102,7 +102,10 @@ 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**
This means both the SDK and Databroker are running in a kinda "bleeding edge" state in their currently developed version.

![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.
Expand Down

0 comments on commit 04ef185

Please sign in to comment.