Commit 05ecf600 authored by Maximilian Dolling's avatar Maximilian Dolling

renamed project, fixed doc, code, ...

parent 022f19e4
......@@ -6,17 +6,17 @@ stages:
- build-deploy:dep
- build-deploy
- test
- ci-services
- sqa
variables:
VERSION: 0.4.2
DOCKER_DST_IMAGE_NAME: ci-services
DOCKER_DST_IMAGE_NAME: software-quality-assurance
build-deploy:dep:
stage: build-deploy:dep
image: docker:19.03.1
tags:
- ci-services
- sqa
variables:
DOCKER_FILE: build/docker/dep/Dockerfile
before_script:
......@@ -33,7 +33,7 @@ build-deploy:dev:
stage: build-deploy
image: docker:19.03.1
tags:
- ci-services
- sqa
dependencies:
- build-deploy:dep
variables:
......@@ -42,7 +42,7 @@ build-deploy:dev:
- echo "$CI_BUILD_TOKEN" | docker login -u "$CI_REGISTRY_USER" --password-stdin "$CI_REGISTRY"
script:
- echo $CI_REGISTRY_IMAGE
- CI_REGISTRY_IMAGE=gitext.gfz-potsdam.de:5000/software/services/fair/ci-services
- CI_REGISTRY_IMAGE=gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance
- echo $CI_REGISTRY_IMAGE
- docker build --pull -t "${CI_REGISTRY_IMAGE}/$DOCKER_DST_IMAGE_NAME:latest-dev" -f $DOCKER_FILE ${DOCKER_BUILD_PATH:-.}
......@@ -59,7 +59,7 @@ build-deploy:production:
stage: build-deploy
image: docker:19.03.1
tags:
- ci-services
- sqa
dependencies:
- build-deploy:dep
variables:
......@@ -83,7 +83,7 @@ test:pylint:
allow_failure: true
image: python:3
tags:
- ci-services
- sqa
before_script:
- pip install pylint
script:
......@@ -101,7 +101,7 @@ test:python-unittest:
stage: test
image: python:3
tags:
- ci-services
- sqa
before_script:
- pip install -r test/unittests/requirements.txt
script:
......@@ -118,7 +118,7 @@ test:dev:
name: "${CI_REGISTRY_IMAGE}/$DOCKER_DST_IMAGE_NAME:latest-dev"
entrypoint: [""]
tags:
- ci-services
- sqa
dependencies:
- build-deploy:dev
script:
......@@ -127,7 +127,7 @@ test:dev:
- docker-entrypoint.sh --test
- cp -rT /repo "$CI_PROJECT_DIR"
- tail -n +7 test/test_report.md > test/tmp_test_report.md
- IS_CHK_SUM=$(sha512sum meta/ci-services-report.md | awk '{ print $1 }')
- 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 }')
- >
if [ "$IS_CHK_SUM" != "$PASS_CHK_SUM" ]; then
......@@ -155,7 +155,7 @@ test:production:
name: "${CI_REGISTRY_IMAGE}/$DOCKER_DST_IMAGE_NAME:latest"
entrypoint: [""]
tags:
- ci-services
- sqa
dependencies:
- build-deploy:production
script:
......@@ -164,7 +164,7 @@ test:production:
- docker-entrypoint.sh --test
- cp -rT /repo "$CI_PROJECT_DIR"
- tail -n +7 test/test_report.md > test/tmp_test_report.md
- IS_CHK_SUM=$(sha512sum meta/ci-services-report.md | awk '{ print $1 }')
- 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 }')
- >
if [ "$IS_CHK_SUM" != "$PASS_CHK_SUM" ]; then
......@@ -186,13 +186,13 @@ test:production:
when: on_failure
expire_in: 1 day
ci-services:dev:
stage: ci-services
sqa:dev:
stage: sqa
image:
name: "${CI_REGISTRY_IMAGE}/$DOCKER_DST_IMAGE_NAME:latest-dev"
entrypoint: [""]
tags:
- ci-services
- sqa
dependencies:
- test:dev
before_script:
......@@ -204,7 +204,7 @@ ci-services:dev:
- eval $(ssh-agent -s)
- 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 "ci-services@gitext.gfz-potsdam.de"
- git config user.email "software-quality-assurance@gitext.gfz-potsdam.de"
- cp -r "$CI_PROJECT_DIR" /repo
- docker-entrypoint.sh --all
- cp -rT /repo "$CI_PROJECT_DIR"
......@@ -212,26 +212,26 @@ ci-services:dev:
- find -mindepth 1 -maxdepth 1 -type d -exec rm -r {} \;
- cd ..
- git add -f .
- git commit -m "[AUTOMATIC] generated meta/ci-services-report.md by gitlab ci"
- git commit -m "[AUTOMATIC] generated meta/software-quality-assurance-report.md by gitlab ci"
- git push "git@${CI_SERVER_HOST}:${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}.git" "HEAD:${CI_COMMIT_REF_NAME}"
- exit 0
except:
refs:
- master
changes:
- "meta/ci-services-report.md"
- "meta/software-quality-assurance-report.md"
artifacts:
paths:
- "meta/ci-services-report.md"
- "meta/software-quality-assurance-report.md"
expire_in: 1 day
ci-services:production:
stage: ci-services
sqa:production:
stage: sqa
image:
name: "${CI_REGISTRY_IMAGE}/$DOCKER_DST_IMAGE_NAME:latest"
entrypoint: [""]
tags:
- ci-services
- sqa
dependencies:
- test:production
before_script:
......@@ -243,7 +243,7 @@ ci-services:production:
- eval $(ssh-agent -s)
- 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 "ci-services@gitext.gfz-potsdam.de"
- git config user.email "software-quality-assurance@gitext.gfz-potsdam.de"
- cp -r "$CI_PROJECT_DIR" /repo
- docker-entrypoint.sh --all
- cp -rT /repo "$CI_PROJECT_DIR"
......@@ -251,7 +251,7 @@ ci-services:production:
- find -mindepth 1 -maxdepth 1 -type d -exec rm -r {} \;
- cd ..
- git add -f .
- git commit -m "[AUTOMATIC] generated meta/ci-services-report.md by gitlab ci"
- git commit -m "[AUTOMATIC] generated meta/software-quality-assurance-report.md by gitlab ci"
- git push "git@${CI_SERVER_HOST}:${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}.git" "HEAD:${CI_COMMIT_REF_NAME}"
- exit 0
only:
......@@ -259,8 +259,8 @@ ci-services:production:
- master
except:
changes:
- "meta/ci-services-report.md"
- "meta/software-quality-assurance-report.md"
artifacts:
paths:
- "meta/ci-services-report.md"
- "meta/software-quality-assurance-report.md"
expire_in: 1 day
......@@ -4,7 +4,7 @@ SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Cent
SPDX-License-Identifier: CC0-1.0
-->
# CI-Services
# Software Quality Assurance
---
......
......@@ -4,7 +4,7 @@ SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Cent
SPDX-License-Identifier: CC0-1.0
-->
# CI-Services
# Software Quality Assurance
---
......
......@@ -4,7 +4,7 @@ SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Cent
SPDX-License-Identifier: CC0-1.0
-->
# CI-Services
# Software Quality Assurance
---
......@@ -20,13 +20,13 @@ You can contribute in many ways:
#### Report Bugs
Report bugs as [issue](https://gitext.gfz-potsdam.de/software/services/fair/ci-services/-/issues).
Report bugs as [issue](https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/issues).
If you are reporting a bug, please include:
* The docker version used.
* The section of the `.gitlab-ci.yml` where you call the ci-services.
* Your `ci-services-report.md`, if it was generated
* The section of the `.gitlab-ci.yml` where you call the Software Quality Assurance.
* Your `software-quality-assurance-report.md`, if it was generated
* Detailed steps to reproduce the bug.
#### Fix Bugs
......@@ -41,12 +41,12 @@ Anything tagged with "enhancement" and "help wanted" is open to whoever wants to
#### Write Documentation
CI-Services could always use more documentation.
Software Quality Assurance could always use more documentation.
Whether as part of the official docs or in the docstrings.
#### Submit Feedback
The best way to send feedback is to file an issue at https://gitext.gfz-potsdam.de/software/services/fair/ci-services/-/issues.
The best way to send feedback is to file an issue at https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/issues.
If you are proposing a feature:
......@@ -58,12 +58,12 @@ If you are proposing a feature:
##### How to
Ready to contribute? Here's how to set up `CI-Services` for local development.
Ready to contribute? Here's how to set up `Software Quality Assurance` for local development.
1. Fork the `CI-Services` repo on GitLab.
1. Fork the `Software Quality Assurance` repo on GitLab.
2. Clone your fork locally:
```shell
$ git clone git@gitext.gfz-potsdam.de:your_name_here/ci-services.git
$ git clone git@gitext.gfz-potsdam.de:your_name_here/software-quality-assurance.git
```
3. Create a branch for local development:
```shell
......@@ -97,5 +97,5 @@ Before you submit a pull request, check that it meets these guidelines:
1. The merge request should include tests.
2. If the merge request adds functionality, the docs should be updated.
3. Check your [merge request](https://gitext.gfz-potsdam.de/software/services/fair/ci-services/-/merge_requests) and make sure that the tests pass.
3. Check your [merge request](https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/merge_requests) and make sure that the tests pass.
4. All changes need to be compatible with the respective [license](LICENSE.md).
\ No newline at end of file
......@@ -4,7 +4,7 @@ SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Cent
SPDX-License-Identifier: CC0-1.0
-->
# CI-Services
# Software Quality Assurance
---
......@@ -17,7 +17,7 @@ Its goal is to help researchers, developers and [RSEs](https://de-rse.org/en/) d
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/ci-services-report.md)
> **Example:** You can find a full report of all available services [here](meta/software-quality-assurance-report.md)
**Current available services:**
* Programming Language Detection
......@@ -33,7 +33,7 @@ The software you want to run the services on **must** be a [git](https://git-scm
**via GitLab CI/CD**
* available [GitLab Runner](https://docs.gitlab.com/runner/) with `ci-services` [tag](https://docs.gitlab.com/ee/ci/runners/#using-tags) and the [docker executor](https://docs.gitlab.com/runner/executors/docker.html)
* available [GitLab Runner](https://docs.gitlab.com/runner/) with `software-quality-assurance` [tag](https://docs.gitlab.com/ee/ci/runners/#using-tags) and the [docker executor](https://docs.gitlab.com/runner/executors/docker.html)
**local usage**
......
# ci-services
# Software Quality Assurance
# This Software provides services to check and improve the source code quality of software-projects
#
# SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences Potsdam, Germany (https://www.gfz-potsdam.de/)
......
# ci-services
# Software Quality Assurance
# This Software provides services to check and improve the source code quality of software-projects
#
# SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences Potsdam, Germany (https://www.gfz-potsdam.de/)
......@@ -26,7 +26,7 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
FROM gitext.gfz-potsdam.de:5000/software/services/fair/ci-services/ci-services:latest-dep
FROM gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep
LABEL maintainer="Maximilian Dolling <mdolling@gfz-potsdam.de>"
......
#!/usr/bin/env sh
# ci-services
# Software Quality Assurance
# This Software provides services to check and improve the source code quality of software-projects
#
# SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences Potsdam, Germany (https://www.gfz-potsdam.de/)
......@@ -43,12 +43,12 @@ if [ ! -d /repo ]; then
exit 1
fi
# checks if a .ci-service.yml exists
if [ ! -f /repo/.ci-services.yml ]; then
# checks if a .sqa.yml exists
if [ ! -f /repo/.sqa.yml ]; then
cat /usr/local/bin/entrypoint-manual.txt
echo
echo "Repository does not contain a config for the ci-services."
echo "Visit https://gitext.gfz-potsdam.de/software/services/fair/ci-services/-/blob/master/doc/doc_service_description.md#general"
echo "Repository does not contain a config for the Software Quality Assurance."
echo "Visit https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/blob/master/doc/doc_service_description.md#general"
echo "for more information"
exit 1
fi
......
......@@ -5,7 +5,7 @@ Runs various services for software quality detection.
Needs a directory to run services on bound to '/repo'.
The directory needs to be a git repository and needs to contain a config yaml.
Visit https://gitext.gfz-potsdam.de/software/services/fair/ci-services for more help.
Visit https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance for more help.
Available services:
--all runs all services (reporting is last)
......@@ -16,5 +16,5 @@ Available services:
--list-used-languages lists used programming languages in given repo
--list-used-licenses lists all used libraries and their licenses
--reuse-lint runs the reuse linter
--test same as -a but ignore the exclude section in .ci-services.yml
--version returns version of ci-services
\ No newline at end of file
--test same as -a but ignore the exclude section in .sqa.yml
--version returns version of Software Quality Assurance
\ No newline at end of file
# ci-services
# Software Quality Assurance
# This Software provides services to check and improve the source code quality of software-projects
#
# SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences Potsdam, Germany (https://www.gfz-potsdam.de/)
......@@ -26,7 +26,7 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
FROM gitext.gfz-potsdam.de:5000/software/services/fair/ci-services/ci-services:latest-dep
FROM gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep
LABEL maintainer="Maximilian Dolling <mdolling@gfz-potsdam.de>"
......
#!/usr/bin/env sh
# ci-services
# Software Quality Assurance
# This Software provides services to check and improve the source code quality of software-projects
#
# SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences Potsdam, Germany (https://www.gfz-potsdam.de/)
......@@ -43,21 +43,21 @@ if [ ! -d /repo ]; then
exit 1
fi
# checks if a .ci-service.yml exists
if [ ! -f /repo/.ci-services.yml ]; then
# checks if a .sqa.yml exists
if [ ! -f /repo/.sqa.yml ]; then
cat /usr/local/bin/entrypoint-manual.txt
echo
echo "Repository does not contain a config for the ci-services."
echo "Visit https://gitext.gfz-potsdam.de/software/services/fair/ci-services/-/blob/master/doc/doc_service_description.md#general"
echo "Repository does not contain a config for the Software Quality Assurance."
echo "Visit https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/blob/master/doc/doc_service_description.md#general"
echo "for more information"
exit 1
fi
# checks if a .ci-service.yml exists
if [ ! -f /repo/.ci-services.yml ]; then
# checks if a .sqa.yml exists
if [ ! -f /repo/.sqa.yml ]; then
echo
echo "Repository does not contain a config for the ci-services."
echo "Visit https://gitext.gfz-potsdam.de/software/services/fair/ci-services/-/blob/master/doc/doc_service_description.md#general"
echo "Repository does not contain a config for the Software Quality Assurance."
echo "Visit https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/blob/master/doc/doc_service_description.md#general"
echo "for more information"
cat /usr/local/bin/entrypoint-manual.txt
exit 1
......
......@@ -5,7 +5,7 @@ Runs various services for software quality detection.
Needs a directory to run services on bound to '/repo'.
The directory needs to be a git repository and needs to contain a config yaml.
Visit https://gitext.gfz-potsdam.de/software/services/fair/ci-services for more help.
Visit https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance for more help.
Available services:
--all runs all services (reporting is last)
......@@ -16,5 +16,5 @@ Available services:
--list-used-languages lists used programming languages in given repo
--list-used-licenses lists all used libraries and their licenses
--reuse-lint runs the reuse linter
--test same as -a but ignore the exclude section in .ci-services.yml
--version returns version of ci-services
\ No newline at end of file
--test same as -a but ignore the exclude section in .sqa.yml
--version returns version of software-quality-assurance
\ No newline at end of file
......@@ -4,16 +4,16 @@ SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Cent
SPDX-License-Identifier: CC0-1.0
-->
# CI-Services
# Software Quality Assurance
---
### 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:
These settings will be done in a `.sqa.yaml` file in the root directory of the project.
An example for a [.sqa.yaml](.sqa.yml) can be found in this project.
A minimal config is located [here](test/tetfiles/.min_sqa.yml) and an empty commented file below:
```yaml
# exclude patterns for license check
......
......@@ -4,7 +4,7 @@ SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Cent
SPDX-License-Identifier: CC0-1.0
-->
# CI-Services
# Software Quality Assurance
---
......@@ -94,7 +94,7 @@ Afterwards requests the license from the PyPI API.
It will only handle libraries with specified versions '=='.
All other specifications (<>!~) are not supported.
All packages that are not hosted on PyPI are not handled.
Local packages can be excluded in the `.ci-services.yml`.
Local packages can be excluded in the `.sqa.yml`.
##### all others
......
......@@ -4,22 +4,22 @@ SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Cent
SPDX-License-Identifier: CC0-1.0
-->
# CI-Services
# Software Quality Assurance
---
## CI/CD usage
The following manual describes how to use the ci-services with GitLab CI/CD.
The following manual describes how to use the Software Quality Assurance with GitLab CI/CD.
It is highly advisable to know how to use git and GitLab when using this method.
> **Note:** It is possible to hook the ci-services to GitHub Actions and other code hosting platforms.
> **Note:** It is possible to hook the Software Quality Assurance to GitHub Actions and other code hosting platforms.
---
## Decide on way to retrieve the report
There are two different ways to get the generated report by the `ci-services`.
There are two different ways to get the generated report by the `Software Quality Assurance`.
**Artifact**
......@@ -48,12 +48,12 @@ Enable `Pipelines` and set them to `Only Project Members`.
### 4) Add GitLab Runner
To have an available Runner is **required** for the ci-services to function.
To have an available Runner is **required** for the Software Quality Assurance to function.
This will not be covered here.
Talk to your local admin get one up and running.
**Runner requirements**
* tag: `ci-services`
* tag: `sqa`
* executor: docker
> **WARNING:** Be aware that the runtime for the services can go up to several hours, depending on the project size!
......@@ -74,15 +74,15 @@ Commit and push your changes.
```yaml
stages:
- ci-services
- sqa
ci-services:
stage: ci-services
sqa:
stage: sqa
image:
name: "gitext.gfz-potsdam.de:5000/software/services/fair/ci-services/ci-services:latest"
name: "gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance/software-quality-assurance:latest"
entrypoint: [""]
tags:
- ci-services
- sqa
script:
- cp -r "$CI_PROJECT_DIR" /repo
- rm -rf /repo/meta
......@@ -93,7 +93,7 @@ ci-services:
- master
artifacts:
paths:
- meta/ci-services-report.md
- meta/software-quality-assurance-report.md
expire_in: 30 days
```
......@@ -112,7 +112,7 @@ It will function as [deploy key](https://docs.gitlab.com/ee/ssh/#deploy-keys).
More information on generating a key pair can be found [here](https://docs.gitlab.com/ee/ssh/#generating-a-new-ssh-key-pair).
```console
ssh-keygen -t rsa -b 4096 -C "[PROJECT_NAME]_ci-services" -f [OUTPUTFILE] -q -N ""
ssh-keygen -t rsa -b 4096 -C "[PROJECT_NAME]_software-quality-assurance" -f [OUTPUTFILE] -q -N ""
```
In the GitLab web-interface from the page of your repository navigate to `Settings > CI/CD > Deploy Keys`.
......@@ -162,15 +162,15 @@ Commit and push your changes.
```yaml
stages:
- ci-services
- sqa
ci-services:
stage: ci-services
sqa:
stage: sqa
image:
name: "gitext.gfz-potsdam.de:5000/software/services/fair/ci-services/ci-services:latest"
name: "gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance/software-quality-assurance:latest"
entrypoint: [""]
tags:
- ci-services
- sqa
before_script:
- mkdir -p ~/.ssh
- chmod 700 ~/.ssh
......@@ -180,7 +180,7 @@ ci-services:
- eval $(ssh-agent -s)
- 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 "[PROJECT_NAME]_ci-services"
- git config user.email "[PROJECT_NAME]_software-quality-assurance"
- cp -r "$CI_PROJECT_DIR" /repo
- docker-entrypoint.sh --all
- cp -rT /repo "$CI_PROJECT_DIR"
......@@ -188,18 +188,18 @@ ci-services:
- find -mindepth 1 -maxdepth 1 -type d -exec rm -r {} \;
- cd ..
- git add -f .
- git commit -m "[AUTOMATIC] generated meta/ci-services-report.md by gitlab ci"
- git commit -m "[AUTOMATIC] generated meta/software-quality-assurance-report.md by gitlab ci"
- git push "git@${CI_SERVER_HOST}:${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}.git" "HEAD:${CI_COMMIT_REF_NAME}"
only:
refs:
- master
except:
changes:
- "meta/ci-services-report.md"
- "meta/software-quality-assurance-report.md"
```
**Important**
In the yaml file above fill in the line `- git config user.email "[PROJECT_NAME]_ci-services"`
In the yaml file above fill in the line `- git config user.email "[PROJECT_NAME]_software-quality-assurance"`
The content of user.email must be identical with what was entered in 5.2.1)
> **Note:** it is recommended to either store `[OUTPUTFILE]` securely or delete it.
......
......@@ -4,13 +4,13 @@ SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Cent
SPDX-License-Identifier: CC0-1.0
-->
# CI-Services
# Software Quality Assurance
---
## Local usage
The following manual describes how to use the ci-services on a local machine.
The following manual describes how to use the Software Quality Assurance on a local machine.
This manual focuses on [UNIX](https://en.wikipedia.org/wiki/Unix) systems like Linux or MacOS.
> **Note:** for Windows the commands can slightly differ, but is fully compatible.
......@@ -29,7 +29,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/).
### 2) Execute ci-services
### 2) Execute Software Quality Assurance
Start the docker service:
```console
......@@ -38,20 +38,20 @@ systemctl start docker.service
The general syntax looks like the following:
```console
docker run -v [/ABSOLUTE/PATH/TO/REPO]:/repo gitext.gfz-potsdam.de:5000/software/services/fair/ci-services/ci-services:latest [SERVICE]
docker run -v [/ABSOLUTE/PATH/TO/REPO]:/repo gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance/software-quality-assurance:latest [SERVICE]
```
To get a list of available services use:
```console
docker run -v [/ABSOLUTE/PATH/TO/REPO]:/repo gitext.gfz-potsdam.de:5000/software/services/fair/ci-services/ci-services:latest --help
docker run -v [/ABSOLUTE/PATH/TO/REPO]:/repo gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance/software-quality-assurance:latest --help
```
### 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/software/services/fair/ci-services/ci-services:latest -all
docker run -v ~/Projects/volcano_detection:/repo gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance/software-quality-assurance:latest -all
```
Get the version of the ci-services. As project directory anything can be used. (using root directory here)
Get the version of the Software Quality Assurance. As project directory anything can be used. (using root directory here)
```console
docker run -v /:/repo gitext.gfz-potsdam.de:5000/software/services/fair/ci-services/ci-services:latest --version
docker run -v /:/repo gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance/software-quality-assurance:latest --version
```
# Software Quality Report
> **Note:** This report is automatically generated by [ci-services](https://gitext.gfz-potsdam.de/software/services/fair/ci-services)
---
## Meta Data
**Software Name:** ci-services
**Software Location:** [gitext](https://gitext.gfz-potsdam.de/software/services/fair/ci-services)
**Last Commit:** e8d80a3503265f644d6885412d5eaa4798a28c9c
**Report Time:** 21/07/2020 10:44:08
**Report Version:** 0.4.2
---