diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 68c4226..2f7cf43 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -3,7 +3,7 @@ variables: before_script: - source "/home/gitlab-runner/.sdkman/bin/sdkman-init.sh" - - sdk u java 11.0.12-open + - sdk d java 11.0.12-open stages: - build @@ -13,13 +13,7 @@ stages: Build Application: stage: build - script: ./gradlew --build-cache build - cache: - key: "$CI_COMMIT_REF_NAME" - policy: push - paths: - - build - - .gradle + script: ./gradlew build Create Documentation: stage: build @@ -28,31 +22,15 @@ Create Documentation: Test Application: stage: test script: ./gradlew check - cache: - key: "$CI_COMMIT_REF_NAME" - policy: pull - paths: - - build - - .gradle sonarqube-check: stage: analysis variables: SONAR_USER_HOME: "${CI_PROJECT_DIR}/.sonar" # Defines the location of the analysis task cache GIT_DEPTH: "0" # Tells git to fetch all the branches of the project, required by the analysis task - cache: - key: "${CI_JOB_NAME}" - paths: - - .sonar/cache script: ./gradlew sonarqube allow_failure: true Publish Artifacts: stage: publish script: ./gradlew publish - cache: - key: "$CI_COMMIT_REF_NAME" - policy: pull - paths: - - build - - .gradle diff --git a/build.gradle b/build.gradle index f1189cd..6db2bad 100644 --- a/build.gradle +++ b/build.gradle @@ -1,89 +1,38 @@ plugins { id 'application' - id 'jacoco' - id 'checkstyle' - id 'pmd' - id "com.github.spotbugs" version "4.8.0" - id "org.sonarqube" version "3.3" - id 'org.asciidoctor.jvm.pdf' version '3.3.0' - id 'org.asciidoctor.jvm.gems' version '3.3.0' - id 'maven-publish' -} - -repositories { - jcenter() - ruby.gems() - mavenLocal() - mavenCentral() - maven { - url "https://gitlab.thpeetz.de/api/v4/packages/maven" - name "GitLab" - } + id 'jacoco-report-aggregation' + alias(versions.plugins.asciidoctorConvention) + alias(versions.plugins.javaConvention) + alias(versions.plugins.sonarqube) } dependencies { - asciidoctorGems 'rubygems:rouge:3.15.0' - implementation 'org.slf4j:slf4j-api:1.7.22' - testImplementation 'org.mockito:mockito-all:1.9.5' - testImplementation("org.junit.jupiter:junit-jupiter:5.8.2") - implementation 'ch.qos.logback:logback-core:1.1.2' - implementation 'ch.qos.logback:logback-classic:1.1.2' + implementation versions.slf4j + implementation versions.commonscli + testImplementation versions.junit + implementation versions.bundles.logback + spotbugsPlugins 'com.h3xstream.findsecbugs:findsecbugs-plugin:1.12.0' } -final BUILD_DATE = new Date().format('dd.MM.yyyy').toString() -def pdfFileEntwicklung = layout.buildDirectory.file("docs/asciidocPdf/Entwicklungshandbuch.pdf") -def pdfArtifactEntwicklung = artifacts.add('archives', pdfFileEntwicklung.get().asFile) { - type 'pdf' - builtBy asciidoctorPdf -} -def pdfFileProjekt = layout.buildDirectory.file("docs/asciidocPdf/Projekthandbuch.pdf") -def pdfArtifactProjekt = artifacts.add('archives', pdfFileProjekt.get().asFile) { - type 'pdf' - builtBy asciidoctorPdf -} -def pdfFilePflichtenheft = layout.buildDirectory.file("docs/asciidocPdf/Pflichtenheft.pdf") -def pdfArtifactPflichtenheft = artifacts.add('archives', pdfFilePflichtenheft.get().asFile) { - type 'pdf' - builtBy asciidoctorPdf -} - -final MAIN_CLASS_NAME = 'com.thpeetz.versabundus.VersabundusApp' -sourceCompatibility = 1.8 - publishing { publications { - mavenEntwicklung(MavenPublication) { - artifactId = "Entwicklungshandbuch" - artifact pdfArtifactEntwicklung - } - mavenProjekt(MavenPublication) { - artifactId = "Projekthandbuch" - artifact pdfArtifactProjekt - } - mavenPflichtenheft(MavenPublication) { - artifactId = "Pflichtenheft" - artifact pdfArtifactPflichtenheft - } application(MavenPublication) { + groupId = group from components.java } } - repositories { - maven { - url "https://gitlab.thpeetz.de/api/v4/projects/${projectId}/packages/maven" - credentials(HttpHeaderCredentials) { - name = "Private-Token" - value = gitLabPrivateToken - } - authentication { - header(HttpHeaderAuthentication) - } - } - } +} + +final BUILD_DATE = new Date().format('dd.MM.yyyy').toString() + +final MAIN_CLASS_NAME = 'com.thpeetz.versabundus.VersabundusApp' + +java { + sourceCompatibility = JavaVersion.VERSION_1_8 } application { - mainClassName = MAIN_CLASS_NAME + mainClass = MAIN_CLASS_NAME } jar { @@ -92,39 +41,10 @@ jar { } } -tasks.named('test') { - useJUnitPlatform() -} - -jacocoTestReport { - reports { - xml.enabled true - } -} - spotbugs { - ignoreFailures = false - showStackTraces = true - showProgress = true - effort = 'default' - reportLevel = 'default' -} - -tasks.withType(Checkstyle) { - ignoreFailures = true - showViolations = false - reports { - xml.enabled true - } -} - -pmd { ignoreFailures = true } - -test.finalizedBy jacocoTestReport - sonarqube { properties { property "sonar.projectKey", "tpeetz_versabundus_AYB03YW5uGIZKMqU5_es" @@ -135,36 +55,13 @@ sonarqube { } } +test.finalizedBy jacocoTestReport + tasks.named('sonarqube').configure { dependsOn test } -asciidoctorPdf { - dependsOn asciidoctorGemsPrepare - - baseDirFollowsSourceFile() - - asciidoctorj { - requires 'rouge' - attributes 'build-gradle': file('build.gradle'), - 'endpoint-url': 'https://www.thpeetz.de', - 'source-highlighter': 'rouge', - 'imagesdir': './images', - 'toc': 'left', - 'toc-title': 'Inhaltsverzeichnis', - 'revdate': BUILD_DATE, - 'revnumber': { project.version.toString() }, - 'revremark': 'Entwurf', - 'chapter-label': '', - 'icons': 'font', - 'idprefix': 'id_', - 'idseparator': '-', - 'docinfo1': '' - } -} - -build.dependsOn(['asciidoctorPdf']) wrapper { - gradleVersion = "6.3" + gradleVersion = "7.5" } diff --git a/gradle.properties b/gradle.properties index 3faad39..6354f31 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,5 +1,4 @@ description = 'Application Versabundus' version=1.0.0-SNAPSHOT -group=de.htpeetz.versabundus +group=de.htpeetz gitLabPrivateToken=bFcsw1ebNhoFgKysksU1 -projectId=28 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 490fda8..249e583 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index a4b4429..8049c68 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-6.3-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index 2fe81a7..a69d9cb 100755 --- a/gradlew +++ b/gradlew @@ -1,7 +1,7 @@ -#!/usr/bin/env sh +#!/bin/sh # -# Copyright 2015 the original author or authors. +# Copyright © 2015-2021 the original authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -17,78 +17,113 @@ # ############################################################################## -## -## Gradle start up script for UN*X -## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# ############################################################################## # Attempt to set APP_HOME + # Resolve links: $0 may be a link -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` +APP_BASE_NAME=${0##*/} # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' # Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" +MAX_FD=maximum warn () { echo "$*" -} +} >&2 die () { echo echo "$*" echo exit 1 -} +} >&2 # OS specific support (must be 'true' or 'false'). cygwin=false msys=false darwin=false nonstop=false -case "`uname`" in - CYGWIN* ) - cygwin=true - ;; - Darwin* ) - darwin=true - ;; - MINGW* ) - msys=true - ;; - NONSTOP* ) - nonstop=true - ;; +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; esac CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + # Determine the Java command to use to start the JVM. if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then # IBM's JDK on AIX uses strange locations for the executables - JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -97,7 +132,7 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" + JAVACMD=java which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. Please set the JAVA_HOME variable in your environment to match the @@ -105,79 +140,101 @@ location of your Java installation." fi # Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi -fi - -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -fi - -# For Cygwin or MSYS, switch paths to Windows format before running java -if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - JAVACMD=`cygpath --unix "$JAVACMD"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi - # Now convert the arguments - kludge to limit ourselves to /bin/sh - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" - fi - i=`expr $i + 1` - done - case $i in - 0) set -- ;; - 1) set -- "$args0" ;; - 2) set -- "$args0" "$args1" ;; - 3) set -- "$args0" "$args1" "$args2" ;; - 4) set -- "$args0" "$args1" "$args2" "$args3" ;; - 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" esac fi -# Escape application args -save () { - for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done - echo " " -} -APP_ARGS=`save "$@"` +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. -# Collect all arguments for the java command, following the shell quoting and substitution rules -eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat index 9109989..53a6b23 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -14,7 +14,7 @@ @rem limitations under the License. @rem -@if "%DEBUG%" == "" @echo off +@if "%DEBUG%"=="" @echo off @rem ########################################################################## @rem @rem Gradle startup script for Windows @@ -25,7 +25,7 @@ if "%OS%"=="Windows_NT" setlocal set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. +if "%DIRNAME%"=="" set DIRNAME=. set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% @@ -40,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init +if %ERRORLEVEL% equ 0 goto execute echo. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. @@ -54,7 +54,7 @@ goto fail set JAVA_HOME=%JAVA_HOME:"=% set JAVA_EXE=%JAVA_HOME%/bin/java.exe -if exist "%JAVA_EXE%" goto init +if exist "%JAVA_EXE%" goto execute echo. echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% @@ -64,38 +64,26 @@ echo location of your Java installation. goto fail -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - :execute @rem Setup the command line set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + @rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* :end @rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd +if %ERRORLEVEL% equ 0 goto mainEnd :fail rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of rem the _cmd.exe /c_ return code! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% :mainEnd if "%OS%"=="Windows_NT" endlocal diff --git a/src/docs/asciidoc/Entwicklungshandbuch.adoc b/src/docs/asciidoc/Entwicklungshandbuch.adoc deleted file mode 100644 index b37473d..0000000 --- a/src/docs/asciidoc/Entwicklungshandbuch.adoc +++ /dev/null @@ -1,69 +0,0 @@ -= Entwicklungshandbuch: Projekt versabundus -:author: Thomas Peetz -:email: -:doctype: article -:toc: -:sectnums: - -== Allgemeines - -=== Zweck des Dokumentes - -Das Entwicklungshandbuch beschreibt die Werkzeuge und die Vorgehensweise bei der Entwicklung -im Projekt generations und der Erstellung der Dokumentation. - -=== Verwendete Tools - -==== Gitlab - -Für die Verwaltung des Sourcecode kommt ((Gitlab))<<2>> zum Einsatz. -Mit Gitlab werden auch die Projektaufgaben verwaltet. - -Das Projekt und das dazugehörige Git Repository sind unter der Adresse - -https://gitlab.ingenieurbuero-peetz.de/tpeetz/generations - -zu finden. - -==== Jenkins - -Zur automatischen Erstellung der Dokumentation und Anwendung wird ((Jenkins))<<4>> als Buildserver integriert. - -Zur Ermittlung der Projekte und Branches ist das Plugin `Gitlab Branch Source` installiert und für die Gruppe `tpeetz` konfiguriert. -Die Konfiguration des Jenkins Jobs wird über ein `Jenkinsfile` gesteuert. -Für jeden Branch der Projekte, das ein Jenkinsfile enthält, wird ein Jenkins Job erzeugt. -Merge Requests und Tags erzeugen ebenfalls Jenkins Jobs. - -Das Projekt kann unter - -https://jenkins.ingenieurbuero-peetz.de/job/its-people/job/its-people%252Fdevops-ki-playground/ - -gefunden werden. - -== Erstellung der Dokumentation - -Die Dokumentation des Projektes wird mit ((Asciidoctor))<<1>> geschrieben. -Die Dokumente erhalten ihre Namen nach dem jeweiligen Hauptdokument. - -=== Quellcode Verwaltung - -Die Asciidoctor-Dateien haben die Endung `.adoc`. - -=== Buildsystem - -Zur Erstellung der PDF-Dateien aus den Asciidoctor-Dateien wird das Buildsystem ((Gradle))<<3>> verwendet. -Die Dateien für die Dokumente liegen im Verzeichnis `src/docs/asciidoc`. - -Der Gradle Build wird über die Datei `build.gradle` definiert. - -[index] -== Index - -[bibliography] -== Referenzen - -- [[[phb]]] Thomas Peetz. Projekthandbuch: Projekt generations. 2020. -- [[[1]]] http://asciidoctor.org -- [[[2]]] http://www.gitlab.org -- [[[3]]] http://www.gradle.org -- [[[4]]] http://jenkins-ci.org diff --git a/src/docs/asciidoc/Pflichtenheft.adoc b/src/docs/asciidoc/Pflichtenheft.adoc deleted file mode 100644 index 3ef0323..0000000 --- a/src/docs/asciidoc/Pflichtenheft.adoc +++ /dev/null @@ -1,89 +0,0 @@ -= Projektbeschreibung versabundus: Pflichtenheft der Anwendung versabundus -:author: Thomas Peetz -:email: -:doctype: article -:sectnums: -:sectnumlevels: 4 -:toc: -:toclevels: 4 -:table-caption!: -:counter: table-number: 0 - - -//[title="Dokumenthistorie", caption="Tabelle {counter:table-number} ", id="Tabelle-{counter:table-number}", options="header"] -//[title="Dokumenthistorie", id="Table-{counter:table-number}", options="header", cols="4"] -[title="Dokumenthistorie", id="Table-{counter:table-number}", options="header"] -|=== -| Version | Datum | Autor | Änderungsgrund / Bemerkungen -| 0.0.1 | 07.10.2014 | Thomas Peetz | Ersterstellung -|=== - -== Einführung - -=== Zweck - -=== Stakeholder des Systems - -=== Systemumfang - -==== Zielsetzung des Systems - -=== Systemübersicht - -==== Systemkontext - -==== Systemarchitektur - -===== Systemkomponente 1 - -===== Systemkomponente 2 - -==== Systemschnittstellen - -===== Realisierte Schnittstellen - -===== Verwendete Schnittstellen - -==== Logisches Datenmodell - -==== Einschränkungen - -== Anforderungen der Domäne - -=== Systemfunktionen - -==== Anwendungsfälle - -==== Akteure - -==== Zielgruppen - -=== Anforderungen - -==== Anforderungen an externe Schnittstellen - -==== Funktionale Anforderungen - -==== Qualitätsanforderungen - -==== Randbedingungen - -==== Weitere Anforderungen - -==== Wartungs- und Supportinformationen - -=== Verifikation - -[bibliography] -== Referenzen - -[glossary] -== Glossar - -== Verzeichnisse - -=== Abbildungsverzeichnis - -=== Tabellenverzeichnis - -<> <> diff --git a/src/docs/asciidoc/Projekthandbuch.adoc b/src/docs/asciidoc/Projekthandbuch.adoc deleted file mode 100644 index c327cc8..0000000 --- a/src/docs/asciidoc/Projekthandbuch.adoc +++ /dev/null @@ -1,80 +0,0 @@ -= Projekthandbuch: Projekt versabundus -:author: Thomas Peetz -:email: -:doctype: book -:toc: left -:sectnums: - -== Zweck des Dokumentes - -Das Projekthandbuch beinhaltet die Informationen zum Projekt generations. - -== Projektbeschreibung - -=== Ausgangslage - - -//==== Rechtliche Vorgaben und Rahmenbedingungen -//=== Rahmenbedingungen - -//==== Vorhandene Regelungen - -=== Projektziele - -=== Projektabgrenzung - -//=== Voraussichtliche Kosten - -//=== Projektrisiken - -//==== Produktivität - -//==== Finanzielle Risiken - -//==== Akzeptanz - -== Projektorganisation - -=== Projekt-Aufbauorganisation - -=== Rollendefinition - -//==== Projektauftraggeber - -//==== Projektausschuss - -//==== Beratung / Qualitätssicherung - -==== Projekteiter - -==== Projektteam - -==== Liste der Stakeholder - -=== Projektablauforganisation - -==== Projekt-Phasen - -===== Erstellung der Projektdokumentation - - -== Verschiedenes - -=== Erreichbarkeiten - -[glossary] -== Glossar - -KI:: Künstliche Intelligenz -ML:: Machine Learning - -[index] -== Index - -[bibliography] -== Referenzen - -- [[[ehb]]] Thomas Peetz. Entwicklungshandbuch: Projekt Generations. 2020. -- [[[1]]] http://asciidoctor.org -- [[[2]]] http://www.gitlab.org -- [[[3]]] http://www.gradle.org diff --git a/src/docs/asciidoc/versabundus.adoc b/src/docs/asciidoc/versabundus.adoc new file mode 100644 index 0000000..806f802 --- /dev/null +++ b/src/docs/asciidoc/versabundus.adoc @@ -0,0 +1,202 @@ += Projektbeschreibung Versabundus: Entwicklungs- und Projekthandbuch +:author: Thomas Peetz +:email: +:doctype: book +:sectnums: +:sectnumlevels: 4 +:toc: +:toclevels: 4 +:table-caption!: +:counter: table-number: 0 + +[title="Dokumenthistorie", id="Table-{counter:table-number}", options="header"] +|=== +| Version | Datum | Autor | Änderungsgrund / Bemerkungen +| 1.0.0 | 16.05.2022 | Thomas Peetz | Ersterstellung +|=== + +== Allgemeines + +=== Zweck des Dokumentes + +Das Entwicklungshandbuch beschreibt die Werkzeuge und die Vorgehensweise bei der Entwicklung +im Projekt Vresabundus und der Erstellung der Dokumentation. + +=== Verwendete Tools + +==== Gitlab + +Für die Verwaltung des Sourcecode kommt ((Gitlab))<> zum Einsatz. +Mit Gitlab werden auch die Projektaufgaben verwaltet. + +Das Projekt und das dazugehörige Git Repository sind unter der Adresse + +https://gitlab.ingenieurbuero-peetz.de/tpeetz/versabundus + +zu finden. + +==== Jenkins + +Zur automatischen Erstellung der Dokumentation und Anwendung wird ((Jenkins))<> als Buildserver integriert. + +Zur Ermittlung der Projekte und Branches ist das Plugin `Gitlab Branch Source` installiert und für die Gruppe `tpeetz` konfiguriert. +Die Konfiguration des Jenkins Jobs wird über ein `Jenkinsfile` gesteuert. +Für jeden Branch der Projekte, das ein Jenkinsfile enthält, wird ein Jenkins Job erzeugt. +Merge Requests und Tags erzeugen ebenfalls Jenkins Jobs. + +Das Projekt kann unter + +https://jenkins.ingenieurbuero-peetz.de/job/its-people/job/its-people%252Fdevops-ki-playground/ + +gefunden werden. + +== Erstellung der Dokumentation + +Die Dokumentation des Projektes wird mit ((Asciidoctor))<> geschrieben. +Die Dokumente erhalten ihre Namen nach dem jeweiligen Hauptdokument. + +=== Quellcode Verwaltung + +Die Asciidoctor-Dateien haben die Endung `.adoc`. + +=== Buildsystem + +Zur Erstellung der PDF-Dateien aus den Asciidoctor-Dateien wird das Buildsystem ((Gradle))<<3>> verwendet. +Die Dateien für die Dokumente liegen im Verzeichnis `src/docs/asciidoc`. + +Der Gradle Build wird über die Datei `build.gradle` definiert. + + +== Einführung + +=== Zweck + +=== Stakeholder des Systems + +=== Systemumfang + +==== Zielsetzung des Systems + +=== Systemübersicht + +==== Systemkontext + +==== Systemarchitektur + +Einzelne Funktionen wie Vererbung, Kommunikation werden als Module implementiert. +Die einzelnen Körper werden aus Modulen zusammengesetzt. +Die Körper existieren nur virtuell, leben also nur im Speicher. +Kann ein Winterschlaf als Speichern implementiert werden? + +==== Systemschnittstellen + +===== Realisierte Schnittstellen + +===== Verwendete Schnittstellen + +==== Logisches Datenmodell + +==== Einschränkungen + +== Anforderungen der Domäne + +=== Systemfunktionen + +==== Anwendungsfälle + +==== Akteure + +==== Zielgruppen + +=== Anforderungen + +==== Anforderungen an externe Schnittstellen + +==== Funktionale Anforderungen + +==== Qualitätsanforderungen + +==== Randbedingungen + +==== Weitere Anforderungen + +==== Wartungs- und Supportinformationen + +=== Verifikation + +== Projektbeschreibung + +=== Ausgangslage + +//==== Rechtliche Vorgaben und Rahmenbedingungen +//=== Rahmenbedingungen + +//==== Vorhandene Regelungen + +=== Projektziele + +=== Projektabgrenzung + +//=== Voraussichtliche Kosten + +//=== Projektrisiken + +//==== Produktivität + +//==== Finanzielle Risiken + +//==== Akzeptanz + +== Projektorganisation + +=== Projekt-Aufbauorganisation + +=== Rollendefinition + +//==== Projektauftraggeber + +//==== Projektausschuss + +//==== Beratung / Qualitätssicherung + +==== Projekteiter + +==== Projektteam + +==== Liste der Stakeholder + +=== Projektablauforganisation + +==== Projekt-Phasen + +===== Erstellung der Projektdokumentation + + +== Verschiedenes + +=== Erreichbarkeiten + +[bibliography] +== Referenzen + +- [[[asciidoctor]]] http://asciidoctor.org +- [[[gitlab]]] http://www.gitlab.org +- [[[gradle]]] http://www.gradle.org +- [[[jenkins]]] http://jenkins-ci.org + +[glossary] +== Glossar + +KI:: Künstliche Intelligenz +ML:: Machine Learning + +[index] +== Index + +== Verzeichnisse + +=== Abbildungsverzeichnis + +=== Tabellenverzeichnis + +<> <>