This software provides a docker image, which provides various services around software quality.
Its goal is to help researchers, developers and [RSEs](https://de-rse.org/en/) develop software with better quality.
Currently there are two ways to run the services.
Either via the [GitLab CI/CD](https://docs.gitlab.com/ee/ci/)(recommended) or a local run.
> **Example:** You can find a full report of all available services [here](meta/ci-services-report.md)
**Current available services:**
* Programming language detection
---
## Requirements
The software you want to run the services on **must** be a [git](https://git-scm.com/) repository!
**via GitLab CI/CD**
* available [GitLab Runner](https://docs.gitlab.com/runner/) with `ci-services`[tag](https://docs.gitlab.com/ee/ci/runners/#using-tags) and the [docker executor](https://docs.gitlab.com/runner/executors/docker.html)
**local usage**
*[docker](https://www.docker.com/) >= 19.03.1
---
## Usage
Running the services via Gitlab CI/CD is the recommended solution.
It keeps the report up to date, every time the project is changed.
You can read more about how it is set up [here](doc/doc_usage_ci.md).
Running it on you local machine is easier to set up.
Therefore it must be triggered manually before every release.
You can read more about how it is set up [here](doc/doc_usage_local.md).