Commit 9f3d2ff4 authored by Maximilian Dolling's avatar Maximilian Dolling

added some documentation

parent 67169faf
......@@ -15,6 +15,8 @@ Either via the [GitLab CI/CD](https://docs.gitlab.com/ee/ci/) (recommended) or a
**Current available services:**
* Programming language detection
* License Check
* Report Generation
---
......@@ -44,6 +46,12 @@ You can read more about how it is set up [here](doc/doc_usage_local.md).
---
## Service Description
You can find a detailed description of all implemented services [here](doc/doc_service_description.md).
---
## Further planned features
* license check
* license header check
......
# CI-Services
---
## Implemented Services
* language detection
* license check
* report
### General
All implemented services will generate a a yaml file in `meta/[SERVICE_NAME]` containing the results.
---
### Language Detection
The language detection service can be run with the `-la` or the `--language` flag when running it either local or via CI/CD.
It runs the software [linguist](https://github.com/github/linguist).
For detailed information on how it works, please see their documentation.
It generates a yaml file, which contains all detected languages and the bytes of code detected.
The source code can be found [here](../src/services/language_detection).
---
### License Check
---
### Report
The report service will read and merge all the sub-reports.
It will then generate a markdown version of the assembled report.
The source code can be found [here](../src/services/report).
\ No newline at end of file
......@@ -11,7 +11,7 @@ This manual focuses on [UNIX](https://en.wikipedia.org/wiki/Unix) systems like L
---
### 3) Assure project is a git repository
### 1) Assure project is a git repository
To run the services on your local machine the first thing to do is to assure, that your software is within a git repository.
If you know, it is a git repository, you can skip this part.
......@@ -23,7 +23,7 @@ git status
If you see `fatal: not a git repository` you don't have a git repository.
Please make sure it becomes one. More information on doing that is available [here](https://swcarpentry.github.io/git-novice/).
### 4) Execute ci-services
### 2) Execute ci-services
Start the docker service:
```console
......@@ -40,7 +40,7 @@ To get a list of available services use:
docker run -v [/ABSOLUTE/PATH/TO/REPO]:/repo gitext.gfz-potsdam.de:5000/hifis/software-services/fair/ci-services/ci-services:latest --help
```
### 5) Examples
### 3) Examples
Run all services for the project within the directory `~/Projects/volcano_detection`.
```console
docker run -v ~/Projects/volcano_detection:/repo gitext.gfz-potsdam.de:5000/hifis/software-services/fair/ci-services/ci-services:latest -a
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment