Commit f7a5b3a7 authored by Maximilian Dolling's avatar Maximilian Dolling
Browse files

Resolve "update docs to new location"

parent fd7d82dc
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
lint:Python: lint:Python:
stage: lint stage: lint
image: gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep-dev image: git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep-dev
before_script: before_script:
- pip install pylint - pip install pylint
script: script:
......
...@@ -19,7 +19,7 @@ sqa:dev: ...@@ -19,7 +19,7 @@ sqa:dev:
- eval $(ssh-agent -s) - eval $(ssh-agent -s)
- echo "$GITLAB_DEPLOY_KEY" | tr -d '\r' | ssh-add - - echo "$GITLAB_DEPLOY_KEY" | tr -d '\r' | ssh-add -
- git config user.name "GitLab CI:${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}" - git config user.name "GitLab CI:${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}"
- git config user.email "software-quality-assurance@gitext.gfz-potsdam.de" - git config user.email "software-quality-assurance@git.gfz-potsdam.de"
- sqa --repository_dir "$CI_PROJECT_DIR" run - sqa --repository_dir "$CI_PROJECT_DIR" run
- git add . - git add .
- git commit -m "[AUTOMATIC] generated meta/software-quality-assurance-report.md by gitlab ci" - git commit -m "[AUTOMATIC] generated meta/software-quality-assurance-report.md by gitlab ci"
...@@ -44,7 +44,7 @@ sqa:production: ...@@ -44,7 +44,7 @@ sqa:production:
- eval $(ssh-agent -s) - eval $(ssh-agent -s)
- echo "$GITLAB_DEPLOY_KEY" | tr -d '\r' | ssh-add - - echo "$GITLAB_DEPLOY_KEY" | tr -d '\r' | ssh-add -
- git config user.name "GitLab CI:${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}" - git config user.name "GitLab CI:${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}"
- git config user.email "software-quality-assurance@gitext.gfz-potsdam.de" - git config user.email "software-quality-assurance@git.gfz-potsdam.de"
- sqa --repository_dir "$CI_PROJECT_DIR" run - sqa --repository_dir "$CI_PROJECT_DIR" run
- git add . - git add .
- git commit -m "[AUTOMATIC] generated meta/software-quality-assurance-report.md by gitlab ci" - git commit -m "[AUTOMATIC] generated meta/software-quality-assurance-report.md by gitlab ci"
......
...@@ -87,3 +87,16 @@ test:docs: ...@@ -87,3 +87,16 @@ test:docs:
changes: changes:
- "docs/**/*" - "docs/**/*"
- "**/*.md" - "**/*.md"
test:check-links:
stage: test
image: ruby:2.7.2-slim-buster
before_script:
- gem install awesome_bot
script:
- awesome_bot --allow-redirect --allow-dupe `find . -type d \( -path .sqa -o -path tests/test_project \) -prune -false -o -name "*.md"`
only:
changes:
- "**/*.md"
- ".gitlab-ci.yml"
- ".gitlab/ci/test.gitlab-ci.yml"
...@@ -17,7 +17,7 @@ You can contribute in many ways: ...@@ -17,7 +17,7 @@ You can contribute in many ways:
### Report Bugs ### Report Bugs
Report bugs as [issue](https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/issues). Report bugs as [issue](https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/-/issues).
If you are reporting a bug, please include: If you are reporting a bug, please include:
...@@ -44,7 +44,7 @@ Whether as part of the official docs or in the docstrings. ...@@ -44,7 +44,7 @@ Whether as part of the official docs or in the docstrings.
### Submit Feedback ### Submit Feedback
The best way to send feedback is to file an issue at https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/issues. The best way to send feedback is to file an issue at https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/-/issues.
If you are proposing a feature: If you are proposing a feature:
...@@ -59,11 +59,11 @@ Ready to contribute? Here's how to set up `Software Quality Assurance` for local ...@@ -59,11 +59,11 @@ Ready to contribute? Here's how to set up `Software Quality Assurance` for local
1. Fork the `Software Quality Assurance` repo on GitLab. 1. Fork the `Software Quality Assurance` repo on GitLab.
2. Clone your fork locally: 2. Clone your fork locally:
```shell ```shell
$ git clone git@gitext.gfz-potsdam.de:your_name_here/software-quality-assurance.git $ git clone git@git.gfz-potsdam.de:your_name_here/software-quality-assurance.git
``` ```
3. Create a branch for local development: 3. Create a branch for local development from the dev branch:
```shell ```shell
$ git checkout -b name-of-your-bugfix-or-feature $ git checkout -b name-of-your-bugfix-or-feature dev
``` ```
Now you can make your changes locally. Now you can make your changes locally.
4. Commit your changes and push your branch to GitLab: 4. Commit your changes and push your branch to GitLab:
...@@ -92,5 +92,5 @@ Before you submit a pull request, check that it meets these guidelines: ...@@ -92,5 +92,5 @@ Before you submit a pull request, check that it meets these guidelines:
1. The merge request should include tests. 1. The merge request should include tests.
2. If the merge request adds functionality, the docs should be updated. 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/software-quality-assurance/-/merge_requests) and make sure that the tests pass. 3. Check your [merge request](https://git.gfz-potsdam.de/id2/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](README.md#license). 4. All changes need to be compatible with the respective [license](README.md#license).
\ No newline at end of file
# Software Quality Report # Software Quality Report
> **Note:** This report is automatically generated by [Software Quality Assurance](https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance) > **Note:** This report is automatically generated by [Software Quality Assurance](https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance)
## Table of Content ## Table of Content
...@@ -18,9 +18,9 @@ ...@@ -18,9 +18,9 @@
**Software Location:** [git](git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance) **Software Location:** [git](git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance)
**Last Commit:** 02c7ad31fc69487750063b02e502a1d7cfa7476b **Last Commit:** fd7d82dcc8478db17bed2c43b8480e003a624f3b
**Report Time:** 30/03/2021 06:51:45 UTC **Report Time:** 30/03/2021 06:56:53 UTC
**Report Version:** 0.6.0 **Report Version:** 0.6.0
...@@ -47,10 +47,10 @@ Usage: gitleaks [OPTIONS]Application Options: -v, --verbose Show v ...@@ -47,10 +47,10 @@ Usage: gitleaks [OPTIONS]Application Options: -v, --verbose Show v
> **Description: Lists all people that committed to this config.** > **Description: Lists all people that committed to this config.**
* [GitLab CI:hifis/software-services/fair/ci-services](mailto:ci-services@gitext.gfz-potsdam.de) * [GitLab CI:hifis/software-services/fair/ci-services](mailto:ci-services@git.gfz-potsdam.de)
* [GitLab CI:id2/software/services/fair/software-quality-assurance](mailto:software-quality-assurance@gitext.gfz-potsdam.de) * [GitLab CI:id2/software/services/fair/software-quality-assurance](mailto:software-quality-assurance@git.gfz-potsdam.de)
* [GitLab CI:software/services/fair/ci-services](mailto:ci-services@gitext.gfz-potsdam.de) * [GitLab CI:software/services/fair/ci-services](mailto:ci-services@git.gfz-potsdam.de)
* [GitLab CI:software/services/fair/software-quality-assurance](mailto:software-quality-assurance@gitext.gfz-potsdam.de) * [GitLab CI:software/services/fair/software-quality-assurance](mailto:software-quality-assurance@git.gfz-potsdam.de)
* [Hannes Fuchs](mailto:hannes.fuchs@gfz-potsdam.de) * [Hannes Fuchs](mailto:hannes.fuchs@gfz-potsdam.de)
* [Maximilian Dolling](mailto:mdolling@gfz-potsdam.de) * [Maximilian Dolling](mailto:mdolling@gfz-potsdam.de)
* [mdolling](mailto:mdolling@gfz-potsdam.de) * [mdolling](mailto:mdolling@gfz-potsdam.de)
......
...@@ -37,7 +37,7 @@ The software you want to run the services on **must** be a [git](https://git-scm ...@@ -37,7 +37,7 @@ The software you want to run the services on **must** be a [git](https://git-scm
## Documentation ## Documentation
You can find the documentation [here](https://id2.git-pages.gfz-potsdam.de/software/services/fair/software-quality-assurance/). You can find the documentation [here](https://id2.git-pages.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/).
In case you received a local copy of the project, you can build and view the documentation like this: In case you received a local copy of the project, you can build and view the documentation like this:
```shell script ```shell script
cd docs cd docs
......
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
# You can find a copy of the license in the LICENSES folder. # You can find a copy of the license in the LICENSES folder.
# If not, see <http://www.gnu.org/licenses/>. # If not, see <http://www.gnu.org/licenses/>.
FROM gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep-dev FROM git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep-dev
LABEL maintainer="Maximilian Dolling <mdolling@gfz-potsdam.de>" LABEL maintainer="Maximilian Dolling <mdolling@gfz-potsdam.de>"
......
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
# You can find a copy of the license in the LICENSES folder. # You can find a copy of the license in the LICENSES folder.
# If not, see <http://www.gnu.org/licenses/>. # If not, see <http://www.gnu.org/licenses/>.
FROM gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep FROM git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep
LABEL maintainer="Maximilian Dolling <mdolling@gfz-potsdam.de>" LABEL maintainer="Maximilian Dolling <mdolling@gfz-potsdam.de>"
......
...@@ -37,8 +37,8 @@ Structure of the Documentation ...@@ -37,8 +37,8 @@ Structure of the Documentation
pages/AUTHORS.md pages/AUTHORS.md
pages/CONTRIBUTING.md pages/CONTRIBUTING.md
pages/CHANGELOG.md pages/CHANGELOG.md
SQA report <https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/blob/master/QUALITY.md> SQA report <https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/-/blob/master/QUALITY.md>
Source Code <https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance> Source Code <https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance>
.. _RSEs: https://de-rse.org/en/ .. _RSEs: https://de-rse.org/en/
.. _git: https://git-scm.com/ .. _git: https://git-scm.com/
......
...@@ -54,7 +54,7 @@ The same reason prevents it currently from being hosted on PyPI. ...@@ -54,7 +54,7 @@ The same reason prevents it currently from being hosted on PyPI.
Please make sure, all requirements are met. Please make sure, all requirements are met.
```shell script ```shell script
git clone https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance.git git clone https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance.git
cd software-quality-assurance/src cd software-quality-assurance/src
python setup.py install python setup.py install
``` ```
......
...@@ -82,7 +82,7 @@ stages: ...@@ -82,7 +82,7 @@ stages:
sqa: sqa:
stage: sqa stage: sqa
image: image:
name: "gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest" name: "git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest"
entrypoint: [""] entrypoint: [""]
script: script:
- sqa --repository_dir "$CI_PROJECT_DIR" run - sqa --repository_dir "$CI_PROJECT_DIR" run
...@@ -131,9 +131,9 @@ ssh-keyscan -t rsa [GITLAB_DOMAIN]] ...@@ -131,9 +131,9 @@ ssh-keyscan -t rsa [GITLAB_DOMAIN]]
# example # example
ssh-keyscan -t rsa gitext.gfz-potsdam.de ssh-keyscan -t rsa git.gfz-potsdam.de
# gitext.gfz-potsdam.de:22 SSH-2.0-OpenSSH_7.6p1 Ubuntu-4ubuntu0.3 # git.gfz-potsdam.de:22 SSH-2.0-OpenSSH_7.6p1 Ubuntu-4ubuntu0.3
gitext.gfz-potsdam.de ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCsiq5txhABcG9oePf47SCd+w/tfSs6NWKaMRd2BfBi9DGORQX4wwV4CYvSJbMfJvQO5SMGwhnEAXe0bWihC2V8X7lzcePrpjfP+uH2lmipcFbV9g3iQpM7Fusr96IV65v/qQ6HE4+KkHJLR1vEKj1AOaVgDww7CHhVAHCkvqcSwwtfOjBbqyfQ2Su7O6UNzs1ecQcIXnQNO8ebzimv3c8mKdo9j8i5eiWVqzRivmi/R3XIIc2T695mTLyxUplqfyvZpDL90F9VEjr/3HM9/3dASbonaTH8SoMRCxOy8Fpz0Va1MdpSor0uoemQjbu8aZzGB0+tsE5eWjuFaZib8QDF git.gfz-potsdam.de ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCsiq5txhABcG9oePf47SCd+w/tfSs6NWKaMRd2BfBi9DGORQX4wwV4CYvSJbMfJvQO5SMGwhnEAXe0bWihC2V8X7lzcePrpjfP+uH2lmipcFbV9g3iQpM7Fusr96IV65v/qQ6HE4+KkHJLR1vEKj1AOaVgDww7CHhVAHCkvqcSwwtfOjBbqyfQ2Su7O6UNzs1ecQcIXnQNO8ebzimv3c8mKdo9j8i5eiWVqzRivmi/R3XIIc2T695mTLyxUplqfyvZpDL90F9VEjr/3HM9/3dASbonaTH8SoMRCxOy8Fpz0Va1MdpSor0uoemQjbu8aZzGB0+tsE5eWjuFaZib8QDF
``` ```
Now open the GitLab web-interface and navigate to `Settings > 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.
...@@ -164,7 +164,7 @@ stages: ...@@ -164,7 +164,7 @@ stages:
sqa: sqa:
stage: sqa stage: sqa
image: image:
name: "gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest" name: "git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest"
entrypoint: [""] entrypoint: [""]
before_script: before_script:
- mkdir -p ~/.ssh - mkdir -p ~/.ssh
...@@ -193,7 +193,7 @@ The content of user.email must be identical with what was entered in 5.2.1) ...@@ -193,7 +193,7 @@ The content of user.email must be identical with what was entered in 5.2.1)
### Examples ### Examples
An example of both variants applied at the same time can be found [here](https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/blob/master/.gitlab/ci/sqa.gitlab-ci.yml) An example of both variants applied at the same time can be found [here](https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/-/blob/master/.gitlab/ci/sqa.gitlab-ci.yml)
## Local ## Local
...@@ -234,7 +234,7 @@ The general syntax looks like the following: ...@@ -234,7 +234,7 @@ The general syntax looks like the following:
```bash ```bash
docker run -v [/ABSOLUTE/PATH/TO/REPO]:/repo \ docker run -v [/ABSOLUTE/PATH/TO/REPO]:/repo \
-u $(id -u ${USER}):$(id -g ${USER}) \ -u $(id -u ${USER}):$(id -g ${USER}) \
gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \ git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \
sqa [MODIFIER] run [SERVICE] sqa [MODIFIER] run [SERVICE]
``` ```
...@@ -246,7 +246,7 @@ This binds the directory of your project to the docker container. ...@@ -246,7 +246,7 @@ This binds the directory of your project to the docker container.
This makes the user/group of the container the same as the host system ones. This makes the user/group of the container the same as the host system ones.
**`gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest`** **`git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest`**
This is the actual path to the image:image-version. This is the actual path to the image:image-version.
...@@ -256,7 +256,7 @@ Here the service (and modifier) to run is specified. ...@@ -256,7 +256,7 @@ Here the service (and modifier) to run is specified.
To get a list of available services use: To get a list of available services use:
```bash ```bash
docker run gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \ docker run git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \
sqa run --help sqa run --help
``` ```
...@@ -266,12 +266,12 @@ Run all services for the project within the directory `~/Projects/volcano_detect ...@@ -266,12 +266,12 @@ Run all services for the project within the directory `~/Projects/volcano_detect
```bash ```bash
docker run -v ~/Projects/volcano_detection:/repo \ docker run -v ~/Projects/volcano_detection:/repo \
-u $(id -u ${USER}):$(id -g ${USER}) \ -u $(id -u ${USER}):$(id -g ${USER}) \
gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \ git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \
sqa run sqa run
``` ```
Get the version of the Software Quality Assurance. Get the version of the Software Quality Assurance.
```bash ```bash
docker run gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \ docker run git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \
sqa --version sqa --version
``` ```
......
...@@ -61,7 +61,7 @@ setup( ...@@ -61,7 +61,7 @@ setup(
long_description=read_file("../README.md"), long_description=read_file("../README.md"),
long_description_content_type="text/markdown", long_description_content_type="text/markdown",
license="GPL-3.0-or-later", license="GPL-3.0-or-later",
url="https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance", url="https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance",
packages=find_packages(exclude=["tests/.*"]), packages=find_packages(exclude=["tests/.*"]),
package_data={ package_data={
"sqa": [ "sqa": [
......
...@@ -84,7 +84,7 @@ def main( ...@@ -84,7 +84,7 @@ def main(
Needs a directory to run services on. Needs a directory to run services on.
The directory needs to be a git repository_config. The directory needs to be a git repository_config.
Visit 'https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance' for more help. Visit 'https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance' for more help.
""" """
if repository_dir[-1:] == "/": if repository_dir[-1:] == "/":
repository_dir = repository_dir[:-1] repository_dir = repository_dir[:-1]
......
...@@ -160,7 +160,7 @@ class SQA: ...@@ -160,7 +160,7 @@ class SQA:
print("##############################") print("##############################")
print( print(
"Note: This report is automatically generated by [Software Quality Assurance]" "Note: This report is automatically generated by [Software Quality Assurance]"
"(https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance)" "(https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance)"
) )
print("##############################") print("##############################")
print("Meta Data") print("Meta Data")
...@@ -180,7 +180,7 @@ class SQA: ...@@ -180,7 +180,7 @@ class SQA:
md_report.write("# Software Quality Report\n") md_report.write("# Software Quality Report\n")
md_report.write( md_report.write(
"> **Note:** This report is automatically generated by [Software Quality Assurance](" "> **Note:** This report is automatically generated by [Software Quality Assurance]("
"https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance)\n\n" "https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance)\n\n"
) )
# write table of content # write table of content
......
Supports Markdown
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