Software Quality Assurance

This framework provides various services for the GitLab CI regarding to software quality.

Description

This software is built as a docker image, which provides various services around software quality. Its goal is to help researchers, developers and RSEs develop software with better quality. Currently there are two ways to run the services.

Example: You can find a full report of all available services here

Requirements

The software you want to run the services on must be a git repository with a remote location named 'origin'.

via GitLab CI/CD

• available GitLab Runner with software-quality-assurance tag and the docker executor

local usage

• docker >= 19.03.1

Documentation

You can find the documentation here. In case you received a local copy of the project, you can build and view the documentation like this:

cd docs
make html
$BROWSER build/html/index.html

Further planned features

• license check
  • R
  • Java
  • Fortran
  • JavaScript
  • C, C++
  • Matlab
• license generation
• comment check
• check for necessary files
• generate necessary files
• check if tests exist
• DOI request
• static code analysis
• linting
• code duplicates

License

Copyright © 2021 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)

This work is licensed under the following license(s):

• Insignificant files are licensed under CC0-1.0
• Software files are licensed under GPL-3.0-or-later
• Everything else is licensed under GPL-3.0-or-later

Please see the individual files for more accurate information.

Hint: We provided the copyright and license information in accordance to the REUSE Specification 3.0.