docs(todos): Removed not needed todos added small documentation that where missing

This commit is contained in:
Marcel Feix 2022-06-24 12:48:14 +02:00
parent ddd2112bad
commit 6a4f3f5efb
No known key found for this signature in database
GPG Key ID: 04D016E104A25F03
7 changed files with 9 additions and 40 deletions

View File

@ -5,7 +5,6 @@ More details and Variables can be found here: https://gitlab.exxcellent.de/gilde
The following variables have to be set and are not optional.
//todo these Variables hav to describet.
.Variables
|===
|Name |Description | Default Value

View File

@ -4,11 +4,12 @@ This template generates a diff between the Liquibase schema and the Hibernate mo
The resulting xml can be used as a base for schema changes.
Please look at the resulting changelog since it can have errors.
//#todo add documentation how to run agains real server oder service
//#If you wand to run against a real server.
//#overrite -Dvariable.liquibase.database.url=<alias> in the script section
//#add a service with your desired Database container.
//#use the alias in the service to define the alias for the database url
== Run against real Server
If you wand to run the integration against a real server.
Override `GRADLE_CLI_OPTS` with `-Dvariable.liquibase.database.url=<database_url>`.
It is also possible to add a service container with your desired Database.
Use the alias field in the service definition to define the address for the for `database_url`
.Variables
|===

View File

@ -132,14 +132,11 @@ include::chapters/templates/static-analysis/sonar-7.adoc[leveloffset=2]
This collection provides templates to simplify your dokumentation prozess.
include::chapters/templates/documentation/tool-documentation-tool.adoc[leveloffset=2]
include::chapters/templates/documentation/documentation.adoc[leveloffset=2]
[#_pipelines]
=== Pipelines
include::chapters/pipelines/eXXcellent-release.adoc[leveloffset=3]
//todo docs for new pipelines
//In particular docs for the keyword needs hinzufügen. needs container build step. artefacts true
//todo licensing documentieren

View File

@ -4,12 +4,6 @@ include:
- '/templates/static-analysis/repo-cve-scan-trivy.gitlab-ci.yml'
- '/templates/static-analysis/sonar-8.gitlab-ci.yml'
# todo docs
# todo Variablen die gesetzt werden müssen
# variables:
# SONAR_PROJECT_KEY: ""
Build-Java:
extends: .gradle-build
@ -22,11 +16,3 @@ Test-Java:
Repo-CVE-Scan:
allow_failure: true
extends: .repo-cve-scan-trivy
#sonar:
# extends: .sonar-gradle
# needs:
# - job: "Build-Java"
# artifacts: true
# variables:
# SONAR_PROJECT_NAME: $CI_PROJECT_NAME

View File

@ -6,12 +6,6 @@ include:
- '/templates/static-analysis/repo-cve-scan-trivy.gitlab-ci.yml'
- '/templates/static-analysis/sonar-8.gitlab-ci.yml'
# todo docs
# todo Variablen die gesetzt werden müssen
# variables:
# SONAR_PROJECT_KEY: ""
Dependencies-Java:
extends: .maven-dependencies
@ -30,11 +24,3 @@ Test-Java:
Repo-CVE-Scan:
allow_failure: true
extends: .repo-cve-scan-trivy
#Sonar:
# extends: .sonar-maven
# needs:
# - job: "Build-Java"
# artifacts: true
# variables:
# SONAR_PROJECT_NAME: $CI_PROJECT_NAME

View File

@ -9,5 +9,5 @@ include:
GRADLE_EXTRA_OPTS: ""
PATH_TO_DIFF: "build/db-diff.xml"
script:
- ./gradlew liquibase:update liquibase:diff $GRADLE_EXTRA_OPTS
- ./gradlew liquibase:update liquibase:diff $GRADLE_CLI_OPTS

View File

@ -11,7 +11,7 @@
script:
- "cd $FRONTEND_DIR"
- npm run lint
# artifacts: todo add lint results in artifact if posible
# artifacts: todo add lint results in artifact if possible
# expire_in: 2 weeks
# when: always
# paths: