Commit be9efc06 authored by Maximilian Dolling's avatar Maximilian Dolling

updated docs

parent 7fcffb52
......@@ -22,7 +22,7 @@ Currently there are two ways to run the services.
## Requirements
The software you want to run the services on **must** be a [git](https://git-scm.com/) repository!
The software you want to run the services on **must** be a [git](https://git-scm.com/) repository with a remote location named 'origin'.
**via GitLab CI/CD**
......
......@@ -13,7 +13,7 @@ Currently there are two ways to run the services.
Requirements
------------
The software you want to run the services on **must** be a git_ repository!
The software you want to run the services on **must** be a git_ repository with a remote location named 'origin'.
**via GitLab CI/CD**
......
......@@ -42,7 +42,7 @@ How to do that, is described [here](https://docs.gitlab.com/ee/gitlab-basics/cre
### Enable CI/CD
In the GitLab web-interface from the page of your repository navigate to `config > General > Visibility, project features, permissions`.
In the GitLab web-interface from the page of your repository navigate to `Settings > General > Visibility, project features, permissions`.
Enable `Pipelines` and set them to `Only Project Members`.
### Add GitLab Runner
......@@ -80,10 +80,8 @@ sqa:
name: "gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance/software-quality-assurance:latest"
entrypoint: [""]
script:
- cp -r "$CI_PROJECT_DIR" /repo
- rm -rf /repo/meta
- ln -s "$CI_PROJECT_DIR" /repo
- sqa [SERVICE] [MODIFIER]
- cp -rT /repo "$CI_PROJECT_DIR"
only:
refs:
- master
......@@ -111,7 +109,7 @@ More information on generating a key pair can be found [here](https://docs.gitla
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 `config > CI/CD > Deploy Keys`.
In the GitLab web-interface from the page of your repository navigate to `Settings > Repository > Deploy Keys`.
Paste the content of `[OUTPUTFILE].pub` to the field `key` and give it any unique name (like *PROJECT_NAME*_deploy-key).
Check the 'Write access allowed' checkbox.
Save the changes.
......@@ -134,7 +132,7 @@ ssh-keyscan -t rsa gitext.gfz-potsdam.de
gitext.gfz-potsdam.de ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCsiq5txhABcG9oePf47SCd+w/tfSs6NWKaMRd2BfBi9DGORQX4wwV4CYvSJbMfJvQO5SMGwhnEAXe0bWihC2V8X7lzcePrpjfP+uH2lmipcFbV9g3iQpM7Fusr96IV65v/qQ6HE4+KkHJLR1vEKj1AOaVgDww7CHhVAHCkvqcSwwtfOjBbqyfQ2Su7O6UNzs1ecQcIXnQNO8ebzimv3c8mKdo9j8i5eiWVqzRivmi/R3XIIc2T695mTLyxUplqfyvZpDL90F9VEjr/3HM9/3dASbonaTH8SoMRCxOy8Fpz0Va1MdpSor0uoemQjbu8aZzGB0+tsE5eWjuFaZib8QDF
```
Now open the GitLab web-interface and navigate to `config > CI/CD > Variables` from from the page of your repository.
Now open the GitLab web-interface and navigate to `Settings > CI/CD > Variables` from from the page of your repository.
We need to fill in two variables here.
Click on 'Add Variable'.
......@@ -174,9 +172,8 @@ sqa:
- 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]_software-quality-assurance"
- cp -r "$CI_PROJECT_DIR" /repo
- ln -s "$CI_PROJECT_DIR" /repo
- sqa [SERVICE] [MODIFIER]
- cp -rT /repo "$CI_PROJECT_DIR"
- 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}"
......@@ -212,11 +209,14 @@ If you know, it is a git repository, you can skip this part.
Open a Terminal and change to the project directory. And then check for git.
```console
cd [PATH_TO_PROJECT]
git status
git remote get-url origin
```
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/).
If you see `fatal: No such remote 'origin'` you have a git repository, but there is no remote location named 'origin'.
Please make sure it has one. More information on doing that is available [here](https://swcarpentry.github.io/git-novice/).
### Execute Software Quality Assurance
Start the docker service:
......@@ -261,7 +261,7 @@ Run all services for the project within the directory `~/Projects/volcano_detect
docker run -v ~/Projects/volcano_detection:/repo \
-u $(id -u ${USER}):$(id -g ${USER}) \
gitext.gfz-potsdam.de:5000/software/services/fair/software-quality-assurance/software-quality-assurance:latest \
-all
--all
```
Get the version of the Software Quality Assurance.
```console
......
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