Commit 6edc5c0e authored by Maximilian Dolling's avatar Maximilian Dolling

added better doc about config

parent 39d3dde1
......@@ -43,6 +43,9 @@ The software you want to run the services on **must** be a [git](https://git-scm
## Usage
Some of the services require a config file.
To see which, take a look at the [service description](doc/doc_service_description.md)
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).
......
<!--
SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences Potsdam, Germany (https://www.gfz-potsdam.de/)
SPDX-License-Identifier: CC0-1.0
-->
# CI-Services
---
### general
Some services require settings.
These settings will be done in a `.ci-services.yaml` file in the root directory of the project.
An example for a [.ci-services.yaml](.ci-services.yml) can be found in this project.
A minimal config is located [here](test/tetfiles/.min_ci-services.yml) and an empty commented file below:
```yaml
# exclude patterns for license check
# list of regular expressions
# every file and directory will be checked if it matched any of the expressions.
list-used-licenses:
exclude:
-
# matching of imported name to name in pkg manager
# sometimes the imported name does not match the pkg name
# they are sorted by programming language
rename:
lib:
language:
import name: 'pkg manager name'
# mark local imports to exclude from license check
# they are sorted by programming language
local_imports:
language:
- 'library name'
# license information used for the reuse tool
apply-license:
description: 'description for license header'
copyright: 'copyright holder for dep5 file'
time: 'time of copyright'
maintainer:
name: 'name of maintainer for dep5 file'
mail: 'mail of maintainer for dep5 file'
licenses:
data:
spdx-identifier: 'spdx-identifier'
copyright: 'copyright holder'
software:
spdx-identifier: 'spdx-identifier'
copyright: 'copyright holder'
pictures:
spdx-identifier: 'spdx-identifier'
copyright: 'copyright holder'
insignificant:
spdx-identifier: 'spdx-identifier'
copyright: 'copyright holder'
```
For more information which services need a config, see the [service description](doc/doc_service_description.md)
\ No newline at end of file
......@@ -20,53 +20,12 @@ SPDX-License-Identifier: CC0-1.0
All implemented services will generate a a yaml file in `meta/[SERVICE_NAME]` containing the results.
Furthermore all settings for the services will be done in a `.ci-services.yaml` file in the root directory of the project.
An example for a [.ci-services.yaml](.ci-services.yml) can be found in this project and an empty commented file below:
```yaml
# exclude patterns for license check
# list of regular expressions
# every file and directory will be checked if it matched any of the expressions.
exclude:
-
# matching of imported name to name in pkg manager
# sometimes the imported name does not match the pkg name
# they are sorted by programming language
rename:
lib:
language:
import name: 'pkg manager name'
# mark local imports to exclude from license check
# they are sorted by programming language
local_imports:
language:
- 'library name'
# license information used for the reuse tool
legal:
description: 'description for license header'
copyright: 'copyright holder for dep5 file'
time: 'time of copyright'
maintainer:
name: 'name of maintainer for dep5 file'
mail: 'mail of maintainer for dep5 file'
licenses:
data:
spdx-identifier: 'spdx-identifier'
copyright: 'copyright holder'
software:
spdx-identifier: 'spdx-identifier'
copyright: 'copyright holder'
pictures:
spdx-identifier: 'spdx-identifier'
copyright: 'copyright holder'
insignificant:
spdx-identifier: 'spdx-identifier'
copyright: 'copyright holder'
```
---
### apply license
> **Note:** config required
This service implements a wrapper for the [reuse tool](https://reuse.software/) by the fsfe.
The main concept of the service is to have dedicated licenses for all files.
This leads to the possibility of multiple licenses for a project.
......@@ -111,6 +70,8 @@ The source code can be found [here](../src/services/list-used-languages).
### list used licenses
> **Note:** config required
The list authors service can be run with the `--list-used-licenses` flag when running it either local or via CI/CD.
The service loads the output from `list-used-languages`.
It takes every files from the repository and assigns them to a detected language.
......
......@@ -107,8 +107,8 @@ SPDX-License-Identifier: CC0-1.0
* Unused licenses:
* Used licenses: CC-BY-4.0, CC0-1.0, GPL-3.0-or-later
* Read errors: 0
* Files with copyright information: 69 / 69
* Files with license information: 69 / 69
* Files with copyright information: 70 / 70
* Files with license information: 70 / 70
Congratulations! Your project is compliant with version 3.0 of the REUSE Specification :-)
......
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