Commit bb63f9ea authored by Maximilian Dolling's avatar Maximilian Dolling

improvements on docs, removed runner tag, symlink instead of copy a repo in ci

parent f747247c
......@@ -5,8 +5,6 @@
build-deploy:dep:
stage: build-deploy:dep
image: docker:19.03.12
tags:
- sqa
variables:
DOCKER_FILE: build/docker/dep/Dockerfile
before_script:
......@@ -25,8 +23,6 @@ build-deploy:dep:
build-deploy:dep-dev:
stage: build-deploy:dep
image: docker:19.03.12
tags:
- sqa
variables:
DOCKER_FILE: build/docker/dep/Dockerfile
before_script:
......@@ -46,8 +42,6 @@ build-deploy:dep-dev:
build-deploy:dev:
stage: build-deploy
image: docker:19.03.12
tags:
- sqa
dependencies:
- build-deploy:dep-dev
variables:
......@@ -69,8 +63,6 @@ build-deploy:dev:
build-deploy:production:
stage: build-deploy
image: docker:19.03.12
tags:
- sqa
dependencies:
- build-deploy:dep
variables:
......
......@@ -5,8 +5,6 @@
pages:
stage: docs
image: python:3-alpine
tags:
- sqa
dependencies:
- test:docs
before_script:
......
......@@ -5,8 +5,6 @@
lint:Python:
stage: lint
image: gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep-dev
tags:
- sqa
before_script:
- pip install pylint
script:
......@@ -20,8 +18,6 @@ lint:Python:
lint:ruby:
stage: lint
image: ruby:latest
tags:
- sqa
before_script:
- gem install rubocop
- cp test/linter/.rubocop.yml /
......@@ -38,8 +34,6 @@ lint:ruby:
lint:shell:
stage: lint
image: alpine:latest
tags:
- sqa
before_script:
- apk update
- apk upgrade
......
......@@ -7,8 +7,6 @@ sqa:dev:
image:
name: "${CI_REGISTRY_IMAGE}/$DOCKER_DST_IMAGE_NAME:latest-dev"
entrypoint: [""]
tags:
- sqa
dependencies:
- test:sqa-dev
before_script:
......@@ -21,31 +19,20 @@ sqa:dev:
- echo "$GITLAB_DEPLOY_KEY" | tr -d '\r' | ssh-add -
- git config user.name "GitLab CI:${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}"
- git config user.email "software-quality-assurance@gitext.gfz-potsdam.de"
- cp -r "$CI_PROJECT_DIR" /repo
- ln -s "$CI_PROJECT_DIR" /repo
- sqa --all
- cp -rT /repo "$CI_PROJECT_DIR"
- cd meta
- find -mindepth 1 -maxdepth 1 -type d -exec rm -r {} \;
- cd ..
- git add -f .
- git add .
- git commit -m "[AUTOMATIC] generated meta/software-quality-assurance-report.md by gitlab ci"
- git push -o ci.skip "git@${CI_SERVER_HOST}:${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}.git" "HEAD:${CI_COMMIT_REF_NAME}"
- exit 0
except:
refs:
- master
artifacts:
paths:
- "meta/software-quality-assurance-report.md"
expire_in: 1 day
sqa:production:
stage: sqa
image:
name: "${CI_REGISTRY_IMAGE}/$DOCKER_DST_IMAGE_NAME:latest"
entrypoint: [""]
tags:
- sqa
dependencies:
- test:sqa-production
before_script:
......@@ -58,20 +45,11 @@ sqa:production:
- echo "$GITLAB_DEPLOY_KEY" | tr -d '\r' | ssh-add -
- git config user.name "GitLab CI:${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}"
- git config user.email "software-quality-assurance@gitext.gfz-potsdam.de"
- cp -r "$CI_PROJECT_DIR" /repo
- ln -s "$CI_PROJECT_DIR" /repo
- sqa --all
- cp -rT /repo "$CI_PROJECT_DIR"
- cd meta
- find -mindepth 1 -maxdepth 1 -type d -exec rm -r {} \;
- cd ..
- git add -f .
- git add .
- git commit -m "[AUTOMATIC] generated meta/software-quality-assurance-report.md by gitlab ci"
- git push -o ci.skip "git@${CI_SERVER_HOST}:${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}.git" "HEAD:${CI_COMMIT_REF_NAME}"
- exit 0
only:
refs:
- master
artifacts:
paths:
- "meta/software-quality-assurance-report.md"
expire_in: 1 day
......@@ -5,8 +5,6 @@
test:python-unittest:
stage: test
image: python:3
tags:
- sqa
before_script:
- pip install -r test/unittests/requirements.txt
script:
......@@ -22,8 +20,6 @@ test:sqa-dev:
image:
name: "${CI_REGISTRY_IMAGE}/$DOCKER_DST_IMAGE_NAME:latest-dev"
entrypoint: [""]
tags:
- sqa
dependencies:
- build-deploy:dev
script:
......@@ -63,15 +59,12 @@ test:sqa-production:
image:
name: "${CI_REGISTRY_IMAGE}/$DOCKER_DST_IMAGE_NAME:latest"
entrypoint: [""]
tags:
- sqa
dependencies:
- build-deploy:production
script:
- cp -r "$CI_PROJECT_DIR" /repo
- ln -s "$CI_PROJECT_DIR" /repo
- rm -rf /repo/meta
- sqa --test
- cp -rT /repo "$CI_PROJECT_DIR"
- tail -n +7 test/test_report.md > test/tmp_test_report.md
- IS_CHK_SUM=$(sha512sum meta/software-quality-assurance-report.md | awk '{ print $1 }')
- PASS_CHK_SUM=$(sha512sum test/tmp_test_report.md | awk '{ print $1 }')
......@@ -101,8 +94,6 @@ test:sqa-production:
test:docs:
stage: test
image: python:3-alpine
tags:
- sqa
before_script:
- apk add make
- pip install -U sphinx sphinx-rtd-theme PyYAML recommonmark
......
......@@ -12,19 +12,12 @@ This framework provides various services for the GitLab CI regarding to software
## Description
This software provides a docker image, which provides various services around software quality.
This software is built as a docker image, which provides various services around software quality.
Its goal is to help researchers, developers and [RSEs](https://de-rse.org/en/) develop software with better quality.
Currently there are two ways to run the services.
Either via the [GitLab CI/CD](https://docs.gitlab.com/ee/ci/) (recommended) or a local run.
> **Example:** You can find a full report of all available services [here](meta/software-quality-assurance-report.md)
**Current available services:**
* Credential Check
* License Check
* List Authors
* Programming Language Detection
* Report Generation
---
## Requirements
......
SQA documentation
==================
This framework provides various services for the GitLab CI regarding to software quality.
**This documentation is structured as follows:**
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.
Requirements
------------
The software you want to run the services on **must** be a git_ repository!
**via GitLab CI/CD**
* available GitLab-Runner_ with the docker-executor_
**local usage**
* docker_ >= 19.03.1
Structure of the Documentation
------------------------------
.. toctree::
:maxdepth: 2
pages/services.md
pages/modifier.md
pages/configuration.md
pages/templates.md
pages/usage.md
pages/services.md
pages/modifier.md
pages/AUTHORS.md
pages/CONTRIBUTING.md
pages/CHANGELOG.md
SQA report <https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/blob/master/meta/software-quality-assurance-report.md>
Source Code <https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance>
.. _RSEs: https://de-rse.org/en/
.. _git: https://git-scm.com/
.. _GitLab-Runner: https://docs.gitlab.com/runner/
.. _docker-executor: https://docs.gitlab.com/runner/executors/docker.html
.. _docker: https://www.docker.com/
......@@ -52,7 +52,6 @@ This will not be covered here.
Talk to your local admin get one up and running.
**Runner requirements**
* tag: `sqa`
* executor: docker
> **WARNING:** Be aware that the runtime for the services can go up to several hours, depending on the project size!
......@@ -80,8 +79,6 @@ sqa:
image:
name: "gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance/software-quality-assurance:latest"
entrypoint: [""]
tags:
- sqa
script:
- cp -r "$CI_PROJECT_DIR" /repo
- rm -rf /repo/meta
......@@ -167,8 +164,6 @@ sqa:
image:
name: "gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance/software-quality-assurance:latest"
entrypoint: [""]
tags:
- sqa
before_script:
- mkdir -p ~/.ssh
- chmod 700 ~/.ssh
......
......@@ -18,11 +18,11 @@
**Software Name:** software-quality-assurance
**Software Location:** [gitext](https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance)
**Software Location:** local
**Last Commit:** f3d75fd6aed0be0d594e24634e9e85e8e251e848
**Last Commit:** 0
**Report Time:** 17/08/2020 06:36:56
**Report Time:** 0
**Report Version:** 0.5.0
......@@ -34,7 +34,7 @@
> **Description: Prints the result of [gitleaks](https://github.com/zricethezav/gitleaks)**
**No leaks detected.**
**999 vulnerabilities found**
### list authors
......@@ -56,11 +56,11 @@
|language|bytes of code|
|---|---|
|Dockerfile|4385|
|HTML|1358|
|Python|73339|
|Ruby|2514|
|Shell|20953|
|Dockerfile|0|
|HTML|0|
|Python|0|
|Ruby|0|
|Shell|0|
### list used licenses
......@@ -72,17 +72,50 @@
|---|---|---|
|Apache 2.0|1|requests|
|GPL-3.0-or-later AND Apache-2.0 AND CC0-1.0 AND CC-BY-SA-4.0|1|reuse|
|MIT|3|PyYAML <br> schema <br> stdlib-list|
|Python-2.0|10|datetime <br> importlib <br> json <br> os <br> pathlib <br> pprint <br> re <br> shutil <br> sys <br> time|
|mock|15|/repo/build/dependencies/check-credentials/install_go_dependencies.sh <br> /repo/build/dependencies/list-used-languages/Gemfile <br> /repo/build/dependencies/list-used-licenses/Gemfile <br> /repo/build/docker/app/Dockerfile <br> /repo/build/docker/app/docker-entrypoint.sh <br> /repo/build/docker/dep/Dockerfile <br> /repo/src/services/apply-license/apply-license.sh <br> /repo/src/services/check-credentials/check-credentials.sh <br> /repo/src/services/generate-report/generate-report.sh <br> /repo/src/services/list-authors/list-authors.sh <br> /repo/src/services/list-used-languages/list-used-languages.sh <br> /repo/src/services/list-used-languages/list_used_languages.rb <br> /repo/src/services/list-used-licenses/list-used-licenses.sh <br> /repo/src/services/reuse-lint/reuse-lint.sh <br> /repo/src/utility/init/init.sh|
|MIT|4|PyYAML <br> httpretty <br> schema <br> stdlib-list|
|Python-2.0|11|datetime <br> importlib <br> json <br> os <br> pathlib <br> pprint <br> re <br> shutil <br> sys <br> time <br> unittest|
|mock|17|/repo/build/dependencies/check-credentials/install_go_dependencies.sh <br> /repo/build/dependencies/list-used-languages/Gemfile <br> /repo/build/dependencies/list-used-licenses/Gemfile <br> /repo/build/docker/app/Dockerfile <br> /repo/build/docker/app/docker-entrypoint.sh <br> /repo/build/docker/dep/Dockerfile <br> /repo/src/services/apply-license/apply-license.sh <br> /repo/src/services/check-credentials/check-credentials.sh <br> /repo/src/services/generate-report/generate-report.sh <br> /repo/src/services/list-authors/list-authors.sh <br> /repo/src/services/list-used-languages/list-used-languages.sh <br> /repo/src/services/list-used-languages/list_used_languages.rb <br> /repo/src/services/list-used-licenses/list-used-licenses.sh <br> /repo/src/services/reuse-lint/reuse-lint.sh <br> /repo/src/utility/init/init.sh <br> /repo/test/generate_local_test_report.sh <br> /repo/test/generate_open_doc.sh|
#### Unknown objects
**unknown language**
* docs/Makefile
* docs/index.rst
* src/services/apply-license/templates/dep5_template
* test/linter/pylintrc
* test/testfiles/unknown_language/test.testlanguage
**unknown license**
* Python / ./downloads/numpy-1.9.2-cp34-none-win32.whl / unknown location
* Python / Mopidy-Dirble / unsupported version modifier (~=1.1)
* Python / beautifulsoup4 / unknown version
* Python / coverage / unsupported version modifier (!=3.5)
* Python / django / unknown version
* Python / docopt / unsupported version modifier (>=0.5.0)
* Python / green / unknown version
* Python / http://wxpython.org/Phoenix/snapshot-builds/wxPython_Phoenix-3.0.3.dev1820+49a8884-cp34-none-win_amd64.whl / unknown location
* Python / igittigitt / unknown license
* Python / keyring / unsupported version modifier (>=4.1.1)
* Python / nose / unknown version
* Python / nose-cov / unknown version
* Python / rejected / unknown version
* Python / sphinx_rtd_theme / unknown version
### reuse linter
......@@ -96,8 +129,8 @@
* Unused licenses:
* Used licenses: CC0-1.0, GPL-3.0-or-later
* Read errors: 0
* Files with copyright information: 86 / 86
* Files with license information: 86 / 86
* Files with copyright information: 85 / 85
* Files with license information: 85 / 85
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