From 6a4f3f5efb97d750f75b0046c55032d57838e331 Mon Sep 17 00:00:00 2001 From: Marcel Feix Date: Fri, 24 Jun 2022 12:48:14 +0200 Subject: [PATCH] docs(todos): Removed not needed todos added small documentation that where missing --- ...-documentation-tool.adoc => documentation.adoc} | 1 - .../java/gradle/gradle-db-diff-template.adoc | 11 ++++++----- documentation/document.adoc | 5 +---- pipelines/java-gradle.gitlab-ci.yml | 14 -------------- pipelines/java-maven.gitlab-ci.yml | 14 -------------- .../java/gradle/gradle-database-diff.gitlab-ci.yml | 2 +- templates/npm/npm-lint.gitlab-ci.yml | 2 +- 7 files changed, 9 insertions(+), 40 deletions(-) rename documentation/chapters/templates/documentation/{tool-documentation-tool.adoc => documentation.adoc} (96%) diff --git a/documentation/chapters/templates/documentation/tool-documentation-tool.adoc b/documentation/chapters/templates/documentation/documentation.adoc similarity index 96% rename from documentation/chapters/templates/documentation/tool-documentation-tool.adoc rename to documentation/chapters/templates/documentation/documentation.adoc index 0192e25..3470b4e 100644 --- a/documentation/chapters/templates/documentation/tool-documentation-tool.adoc +++ b/documentation/chapters/templates/documentation/documentation.adoc @@ -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 diff --git a/documentation/chapters/templates/java/gradle/gradle-db-diff-template.adoc b/documentation/chapters/templates/java/gradle/gradle-db-diff-template.adoc index 849b409..e0a0859 100644 --- a/documentation/chapters/templates/java/gradle/gradle-db-diff-template.adoc +++ b/documentation/chapters/templates/java/gradle/gradle-db-diff-template.adoc @@ -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= 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=`. +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 |=== diff --git a/documentation/document.adoc b/documentation/document.adoc index c391517..1c02560 100644 --- a/documentation/document.adoc +++ b/documentation/document.adoc @@ -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 \ No newline at end of file diff --git a/pipelines/java-gradle.gitlab-ci.yml b/pipelines/java-gradle.gitlab-ci.yml index 57e4cf3..def92c4 100644 --- a/pipelines/java-gradle.gitlab-ci.yml +++ b/pipelines/java-gradle.gitlab-ci.yml @@ -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 diff --git a/pipelines/java-maven.gitlab-ci.yml b/pipelines/java-maven.gitlab-ci.yml index 07909e5..280652a 100644 --- a/pipelines/java-maven.gitlab-ci.yml +++ b/pipelines/java-maven.gitlab-ci.yml @@ -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 diff --git a/templates/java/gradle/gradle-database-diff.gitlab-ci.yml b/templates/java/gradle/gradle-database-diff.gitlab-ci.yml index 194230c..8c9e068 100644 --- a/templates/java/gradle/gradle-database-diff.gitlab-ci.yml +++ b/templates/java/gradle/gradle-database-diff.gitlab-ci.yml @@ -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 diff --git a/templates/npm/npm-lint.gitlab-ci.yml b/templates/npm/npm-lint.gitlab-ci.yml index 18ad525..f5964e1 100644 --- a/templates/npm/npm-lint.gitlab-ci.yml +++ b/templates/npm/npm-lint.gitlab-ci.yml @@ -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: