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

Maximilian Dolling's avatar
Maximilian Dolling committed
3
This Framework provides various services for the GitLab CI regarding to software quality.
4 5
The services are packed into a docker image.
You can run the image locally or by setting up a GitLab CI/CD pipeline.
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
## Currently implemented services
* **test**: runs no actual service, just gives information if everything seems fine
## Running the services
### via GitLab CI/CD
#### requirements
* repo hosted on [GFZ external Gitlab](gitext.gfz-potsdam.de)
### locally
#### requirements
* [docker](https://www.docker.com/)

```bash
docker login gitext.gfz-potsdam.de:5000
docker pull gitext.gfz-potsdam.de:5000/hifis/software-services/fair/ci-services/ci-services:latest
docker run -v [/absolute/path/to/repo]:/repo \
           gitext.gfz-potsdam.de:5000/hifis/software-services/fair/ci-services/ci-services:latest \
           [SERVICE]]
```

## Further planned features
Maximilian Dolling's avatar
Maximilian Dolling committed
26 27 28 29 30 31 32 33 34
* license check
* license header check
* comment check
* language detection
* check for nececary files
* check if tests exist
* credential check
* DOI request
* curate meta data
35 36
* generate report
* test for code hosting