README.md 1.71 KB
Newer Older
Maximilian Dolling's avatar
Maximilian Dolling committed
1 2
# CI-Services

Maximilian Dolling's avatar
Maximilian Dolling committed
3 4
---

5
This framework provides various services for the GitLab CI regarding to software quality.
Maximilian Dolling's avatar
Maximilian Dolling committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45

## Description

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).

---
46 47

## Further planned features
Maximilian Dolling's avatar
Maximilian Dolling committed
48 49
* license check
* license header check
Maximilian Dolling's avatar
Maximilian Dolling committed
50
* license generation
Maximilian Dolling's avatar
Maximilian Dolling committed
51
* comment check
Maximilian Dolling's avatar
Maximilian Dolling committed
52 53
* check for necessary files
* generate necessary files
Maximilian Dolling's avatar
Maximilian Dolling committed
54 55 56 57
* check if tests exist
* credential check
* DOI request
* curate meta data
58

Maximilian Dolling's avatar
Maximilian Dolling committed
59
---
60

Maximilian Dolling's avatar
Maximilian Dolling committed
61
## Help
62

Maximilian Dolling's avatar
Maximilian Dolling committed
63
TODO =)