README.md 2.15 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
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

# tmp

**SSH_KNOWN_HOSTS_GITLAB**
# gitext.gfz-potsdam.de:22 SSH-2.0-OpenSSH_7.6p1 Ubuntu-4ubuntu0.3
gitext.gfz-potsdam.de ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCsiq5txhABcG9oePf47SCd+w/tfSs6NWKaMRd2BfBi9DGORQX4wwV4CYvSJbMfJvQO5SMGwhnEAXe0bWihC2V8X7lzcePrpjfP+uH2lmipcFbV9g3iQpM7Fusr96IV65v/qQ6HE4+KkHJLR1vEKj1AOaVgDww7CHhVAHCkvqcSwwtfOjBbqyfQ2Su7O6UNzs1ecQcIXnQNO8ebzimv3c8mKdo9j8i5eiWVqzRivmi/R3XIIc2T695mTLyxUplqfyvZpDL90F9VEjr/3HM9/3dASbonaTH8SoMRCxOy8Fpz0Va1MdpSor0uoemQjbu8aZzGB0+tsE5eWjuFaZib8QDF
# gitext.gfz-potsdam.de:22 SSH-2.0-OpenSSH_7.6p1 Ubuntu-4ubuntu0.3
gitext.gfz-potsdam.de ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBFiDZULQkGfyG/dFvTtoE3PoANi1PccdjuYfdRId1LaqDEE/sDdwJoy/Ate0DbOoTrjfb22eawUkjVVEmvInXh4=
# gitext.gfz-potsdam.de:22 SSH-2.0-OpenSSH_7.6p1 Ubuntu-4ubuntu0.3
gitext.gfz-potsdam.de ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGRXeIQaIUcyF17/3TTZR2ILHoKqYpAD6/E3s8YTaq8G


**create deploy key**

ssh-keygen -t rsa -b 4096 -C "ci-services"
public key > settings/repository/deploy keys (write access must be allowed)
private key > settings/CI/vars