Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
S
Software Quality Assurance
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
10
Issues
10
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
Operations
Operations
Metrics
Incidents
Packages & Registries
Packages & Registries
Package Registry
Container Registry
Analytics
Analytics
Repository
Value Stream
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
id2
S
Software
S
services
FAIR
Software Quality Assurance
Commits
6edc5c0e
Commit
6edc5c0e
authored
May 27, 2020
by
Maximilian Dolling
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
added better doc about config
parent
39d3dde1
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
70 additions
and
46 deletions
+70
-46
README.md
README.md
+3
-0
doc/doc_config.md
doc/doc_config.md
+60
-0
doc/doc_service_description.md
doc/doc_service_description.md
+5
-44
test/test_report.md
test/test_report.md
+2
-2
No files found.
README.md
View file @
6edc5c0e
...
...
@@ -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
)
.
...
...
doc/doc_config.md
0 → 100644
View file @
6edc5c0e
<!--
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
doc/doc_service_description.md
View file @
6edc5c0e
...
...
@@ -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.
...
...
test/test_report.md
View file @
6edc5c0e
...
...
@@ -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 :-)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment