Features/diagrams

.github/workflows/RenderAllDiagrams.yml

@@ -0,0 +1,104 @@
+name: Render All Diagrams
+
+on:
+  push:
+    paths:
+    - '**/Material/imgsrc/**/*.puml'
+    - '**/Material/imgsrc/**/*.drawio'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v3
+
+      # Installs Java distribution for running the plantUML jar
+      - name: Install Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '11'
+          check-latest: true
+
+      # Install graphviz for plantuml     
+      - name: Setup Graphviz
+        uses: ts-graphviz/setup-graphviz@v1
+
+      # Download plantUML jar 
+      - name: Download plantuml file
+        run: |
+          wget -O plantuml.jar "https://github.com/plantuml/plantuml/releases/download/v1.2023.10/plantuml-1.2023.10.jar" 
+
+      # Runs a single command using the runners shell
+      - name: Generate images
+        run: |
+          imagedir=ImplementationGuide/images/diagrams
+          mkdir -p $imagedir
+          rm -rf ImplementationGuide/images/diagrams/*
+          for fullname in $(find Material/imgsrc/plantuml/ -type f -name '*.puml')
+          do
+              echo "Fullname: ${fullname}"
+              base=$(basename "${fullname}" .puml)
+              dir=$(dirname $fullname)
+              echo "Basename: ${base}"
+              outdir=$(dirname $fullname | sed s+src/plantuml+${imagedir}+)
+              echo "Outdir: ${outdir}"
+              mkdir -p $outdir
+              plantoutdir="${PWD}/${outdir}"
+              echo "PlantOutdir: ${plantoutdir}"
+
+              # PlantUML arguments:
+              # -v for verbose output (Debugging)
+              # -checkmetadata checks whether the target png/svg has the same source
+              # and if there are no changes, doesn't regenerate the image file
+              # -o sets the output folder for the png/svg files
+              plantargs="-v -checkmetadata -o ${plantoutdir} ${fullname}"
+
+              # separate calls are needed, because only one file type can be set
+              # per call
+              java -jar plantuml.jar -tpng ${plantargs} 
+              java -jar plantuml.jar -tsvg ${plantargs}
+
+              # method with pipes
+              #cat "${fullname}" | java -jar plantuml.jar -p -tpng -checkmetadata  > "${outdir}/${base}.png"
+              #cat "${fullname}" | java -jar plantuml.jar -p -tsvg -checkmetadata  > "${outdir}/${base}.svg"
+          done
+          tree ./images
+
+      # creates png files from draw io image files
+      - name: Export drawio files as png
+        uses: rlespinasse/drawio-export-action@v2
+        with:
+          path: ./src/drawio/ 
+          output: .
+          format: png
+          action-mode: all
+
+      # creates svg files from draw io image files
+      - name: Export drawio files 
+        uses: rlespinasse/drawio-export-action@v2
+        with:
+          path: ./src/drawio/ 
+          output: .
+          format: svg
+          action-mode: all
+
+      # copies the created png & svg files to the images/diagrams folder and deletes the drawio files
+      - name: Copy draw io
+        run: |
+          imagedir=images/diagrams
+          cp -RT ./src/drawio $imagedir
+          find $imagedir -name '*.drawio' -exec rm -rv {} \;
+          tree ./images
+
+      # add and commit the new generated files
+      - name: Add & Commit
+        uses: EndBug/add-and-commit@v9
+        with:
+          add: 'ImplementationGuide/images/diagrams/'

.github/workflows/RenderPlantUML.yml

@@ -0,0 +1,47 @@
+name: Render PlantUML diagrams
+
+on:
+  push:
+    paths:
+    - '**/Material/imgsrc/**/*.puml'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get install -y graphviz
+          wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download -O plantuml.jar
+
+      - name: Render and Move SVG files
+        run: |
+          # Find all unique directories containing *.puml files under any /imgsrc/ folder
+          directories=$(find . -path "*/imgsrc/*/*.puml" -exec dirname {} \; | sort -u)
+          for dir in $directories; do
+            # Generate the corresponding out directory path
+            out_dir=${/ImplementationGuide/diagrams}
+            echo $out_dir
+            mkdir -p $out_dir
+
+            # Render SVGs from PUMLs
+            find $dir -name "*.puml" -exec java -jar plantuml.jar -tsvg {} \;
+
+            # Move SVGs to out directory
+            find $dir -name "*.svg" -exec mv {} $out_dir \;
+          done
+
+      - name: Commit and push
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          git add -A
+          git commit -m "Add rendered PlantUML to SVG diagrams" || exit 0
+          git push

.github/workflows/main.yml

@@ -4,11 +4,11 @@ name: CI (FHIR Validation)
 
 # Controls when the action will run. 
 on:
-  # Triggers the workflow on push or pull request events but only for the master branch
+  # Triggers the workflow on all push or pull request events but only for the main branches
   push:
-    branches: [ master ]
+    branches: [ main* ]
   pull_request:
-    branches: [ master ]
+    branches: [ main* ]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -38,14 +38,18 @@ jobs:
           JAVA_VALIDATION_ENABLED: true
           OUTPUT_FORMAT: RAW
           JAVA_VALIDATION_OPTIONS: -allow-example-urls true
-          JAVA_VALIDATOR_VERSION: 6.0.11
           SIMPLIFIER_USERNAME: ${{ secrets.SIMPLIFIER_USERNAME }}
           SIMPLIFIER_PASSWORD: ${{ secrets.SIMPLIFIER_PASSWORD }}
           SUSHI_ENABLED: true
           SUSHI_VERSION: 3.5.0
           SUSHI_OPTIONS: Resources/
           EXPECTED_FAILS: VALIDATION_CONFORMANCE_DOTNET VALIDATION_CONFORMANCE_JAVA VALIDATION_EXAMPLES_JAVA
 
+      # - name: Add & Commit
+      #  uses: EndBug/add-and-commit@v7
+      #  with:
+      #    add: 'Resources/fsh-generated/resources/'
+
       - name: Check for Uncommitted Changes
         run: |
           git diff --exit-code 'Resources/fsh-generated/resources'|| (echo "Es gibt Änderungen durch die Pipeline. Lokale Sushi Konfiguration prüfen!" && exit 1)

.vscode/keybindings.json

@@ -0,0 +1,11 @@
+[
+    {
+        "key": "f5",
+        "command": "workbench.action.tasks.runTask",
+        "args": "buildWithReplaceIncludes"
+    },
+    {
+        "key": "f5",
+        "command": "-workbench.action.debug.start"
+    }
+]

.vscode/tasks.json

@@ -0,0 +1,15 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "buildWithReplaceIncludes",
+            "type": "shell",
+            "command": "./resources/scripts/build_with_replace_includes.sh",
+            "problemMatcher": [],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        }
+    ]
+}

Material/imgsrc/drawio/Klassendiagramm.drawio

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2022-02-03T11:14:10.836Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/15.8.7 Chrome/91.0.4472.164 Electron/13.6.2 Safari/537.36" etag="9FdaCb7Yhk4O1h6U8TQL" version="15.8.7" type="device"><diagram id="C5RBs43oDa-KdzZeNtuy" name="Page-1">7V1rc+I2FP01zLSdgbH8Aj4Gstk+sm3atJu23wwWoI2xqC2WkF9fyZaxLYEfiR/AOpMJ0bUtyzpXukdHkulp0/XLR8/arD5hGzo9VbFfetptT1UBGI7oB7PsQ8tQUULD0kM2Pyk2PKJXyI3RaVtkQz91IsHYIWiTNs6x68I5Sdksz8O79GkL7KTvurGWUDI8zi1Htj4hm6xC60gdxvYfIVquojsDcxweWVvRyfxJ/JVl413CpH3oaVMPYxL+t36ZQodVXlQvTz/tn5z7Z/Pjz7/7/1l/TX7589fP/TCzuzKXHB7Bgy55c9avz4u7Hz/rX/7ePNz9vlM+3sx+7vNLlK+Ws+X19Qna6NkiCLt+/x75BPKHJ/uoRv0dWjuWS1OTBXbJIz+i0LTloKVL/5/TgkKPGr5CjyAKxg0/QPCGWucr5Nj31h5v2eP4xJo/R6nJCnvolWZrOfQQoAZ62CPcr1QzdcYju5Lf2oM+PechqiNwMN1bPuHnzLHjWBsfzYICs1PWlrdE7gQTgtdRRnjr2tDmqQPoQYJ4+PngRuz6gshwBFltwJeEX3KkPkK8hsTb01P4UZ0DwxvdiCd3sQcDk9tWCe8dc5vFG83ykPHhXn/QRma5S1oDh5upWvpuQC94OwpH6naWQ1F3LQInrA79pDvSfxLPGZsCJy3hsEBy2MFgILkorWWScEcHLshJZ/Q31hy5y/vgnFs9tvzBH5SZML124QSOsEK2Dd3AUYhFrNnB+TcYuSSoCWNCf2l9TZWB0TNogaY0DeI0/WWne2RKWxnxLBQ4D6SOuoPMWY+4VWbrzXerfRqwssAm/SiFaFn4dAk+CTsHBV3LiqzjHkBsdjnArilELLsIyT8Z0Ld9IKGtyWhrR5B1rBl0HrCPWLdIbV54roB4W6AaajFQR+/HtP/6+tmY3u8//QWmT1+XDvn3i9JXyzTJ3QoR+EirnJl3lHKkoT7x7EWr7WQdmQV7NC2jA32X45tSJT3QIMseqQuvp8Nr0PAmtBTL4LIpdjB97FsXh9WDHCcy9VRtGvw0F5RVvWjDy+hNT0dlIERlrSgJaCEqD7uoLDf1y4nK4y4qVw5qg1H5OFGWh3bX2CaTIVKvC8ui7KG2Bgo0CcxwnL7uGEQ7A3RTfSMZeNsQXdMLkIHheZABIA/yrrHnKdjZHJru5dABYHR8oHpY2x6ml1LOahumh/V2vuN0VR6oS3UEXfuGzUzQFN4E3UxOEEpHLHr5HXKiqoT2EkYRGjozvPsQGyaBgR6Imk7pgObjrTeHGc/L65GG8CXMxI0P8Vhxi8RH1osmA5bOC+RBxyLoa3pyJiMWPrDGm4iDo3QcBGM1nUX4wPwqNTEbImRk6DkZhTWSn1FfjMxCPnix8GEqi6rirCqPupXB4AfJXQOWlegnc7rlGedaeeILY5Yh6QNq8X4zal98uo8Xq3eYZCvOwPrVeBRIw9fXGoNvJMEHysAXhbdLxa8a+Prt4SerJrTqVr2p1rvRHXlUxiNrIoqKyMpEpciI7UCjsvEuNWp6p3McIQbH/aV4+BhX4y2ipmo25S1A7qyTM+0/uQvsrYOE5DjdcL7+4bwmDOeLau1vk/YN44Im3OUw9S2P5oeFPetcRvOqrB1K6H3zo/nSsLYt76udyPYu/JqU9I/LMTIhkNBrVWigNe7t/2ZZDQxTiwz/BAZFMSPD7cvhbiy1T6YeoIdobTFmEhh7xySECsWMqE7z1YwTKlS94oU+FsI+EFSsouKFOPkAaOMfgiHQ1ZER/B2n861Py6Duae0TZ/Cmf7IKTJH58OgUt6Qwx7dSmONNTaYwrQslhcfP6eaR0ZXULZQMU8DVMs4+/nTyOBsUhq4WkaRB7CoSSQTsAGgKvEPVxODN4CuCK1Y6H81XrBTbxSnecsFiSWEN5P1OUpdYAoxx2m90ozG/kWerknLJZ+hhz3a37lLynE4tEdWSnG7pNOMqrJaoRfWLq5JLjjuuKjnu9Y7L3hLwzkguOV6+Ti6pAda2Fz98U3JJDfi1Lpeo8pokgRBYMw9SQtlxgvPgBLrScYLId+U1RV3nIzfuM+YEBbTajhOUhbV1TvAtzWzWgF/7nKDAvqV2p1BeEAlnUMbjEU+HEyhA58l4+oQl9olEjZMnmZLLpUyeaIICXXjyxFQGynAc/6SyVQ1afi1xVHDe85lKEVewRmtWap1K0WQ996qmUsIupdmpFDHA1aeqarKqekVTKTnYVTSVEpWwAbRkKbGbOyk9d5LjFXXNnUSNOuK648a8poB+eTbrSvRRL7GuBNC43Pa6kkzxKUmNTu+xapwZjcYDc6TEP2Y6vJjqQMlgNIV5k7B2WtrJekbUyBS0KK0JaiRLzFdFjbRs2l8tNWqgn5QF5SviQjlgVcSF0jEO1LGZ4vjTyYJqx4xKM6McH6mLGQmLShpbUqKd/YLbg1pkJLQikCkU1c58rpjQgFOrWM6P0ACB0KhKE4TmypfNai0sm21QPbjqZbM52FUDXXNg6bKsukRsD7GyYPuJJ1Ov4zLv8YfaVB5hgSxobFV8FGovgM0owySdGSjjcZtzXxm76ZrmOeIbPsFI6HAKM5nhGTKZyj1evW46ojfyupO26Iguy9JXREdysLs4OiJLmR0dKUNHcvyhJjoiLInsm3pjDlPgjYFn8Na0uhfPNE4gpJeYvZFARHpCvCRBkOXORwpRR8eLWqsUosuC83VxjxMr/arlHuLbl/qNab+6rP1eE/vIRq9a9tE8drIM2ZGRUmQk2z1qIiNiW2+QjFzKsuA+e5FKJIaE64JNPVonfEYLg3nwy18YXPKdfhW9ElZalyJ0TYVJEMjJ6IxIkLjZSm/gNSqGLFJfFwlqZO1veyTIuOrVvzno1UKC1NyGXRl2svjZkaBSJKiVZcBDYXNJYxzIOLYK2HSYQ8zoP8twY1hoQJHhCSIKOdtke2sR6OLZF/jMvv9V+e51MBnQz9+8peUiP9hzTUmTSsum3Fnz1QZ6fmy52S7Yi5DZxtrvmUsi16YfK0S9SVVet+zvDPo+vRO9QGHuO57OaA5oviIO/fNMi0EPuCxNP20WdX1CH5oMoiLTOkHiY1Bb4tFKNwZrS7DPXbBUM5BbUfJ76XhrCF0+s4lkN6dCHeMbtm2rab83ouiU2NQ3jAJ/alNf+S9goMn4y5JDR4+/clr78D8=</diagram></mxfile>

Material/imgsrc/plantuml/amts_data_objects.puml

@@ -0,0 +1,10 @@
+```plantuml
+@startuml component
+actor client
+node app
+database db
+
+db -> app
+app -> client
+@enduml
+```

README.md

@@ -1,3 +1,5 @@
+![Include Gematik Logo](ImplementationGuide/images/Gematik_Logo_Flag.png)
+
 # About
 This template standardizes the development of fhir resources with .fsh resources. It should reduce time for setup and ease the development process.
 

scripts/build_with_replace_includes.sh

@@ -0,0 +1,67 @@
+#!/bin/bash
+echo "Start building source files"
+
+# check prerequisites
+required_asciidoctor_version="2.0.20"
+actual_asciidoctor_version=$(asciidoctor --version)
+if ! grep -q "$required_asciidoctor_version" <<<"$actual_asciidoctor_version"; then
+    echo "Incorrect asciidoctor version. Expected $required_asciidoctor_version but found $actual_asciidoctor_version"
+    exit 1
+fi
+
+required_asciidoctor_diagram_version="2.2.14"
+actual_asciidoctor_diagram_version=$(gem list | grep "asciidoctor-diagram (")
+if ! grep -q "$required_asciidoctor_diagram_version" <<<"$actual_asciidoctor_diagram_version"; then
+    echo "Incorrect asciidoctor diagram version. Expected $required_asciidoctor_diagram_version but found $actual_asciidoctor_diagram_version"
+    exit 1
+fi
+
+# STAGE_1: creates images from the puml files and will store them in /puml/images
+
+# prepare
+cd "$(dirname "$0")" || exit
+# rm ../../images/puml_*
+
+# loop through all puml files and create the image
+for filename in $(find ../../puml -name '*.puml'); do
+
+    filebase=$(basename -- "$filename") # test.adoc
+    name="${filebase%.*}" # test
+
+    if ! git diff --quiet -- "$filename"; then
+        echo "$filebase has been modified. Creating Puml"
+
+        pumlPath=../puml/${name}.puml
+        newFileRoot=../puml/${name}
+        newFileName=${newFileRoot//-source/}
+        echo "Creating Puml ${name}"
+
+        tempAdocFile=../../docs_sources/${name}.adoc
+
+        # creates a temporary adoc file in order to render with asciidoctor-diagram
+        touch ${tempAdocFile}
+        echo "[plantuml, target=../../images/puml_${name}, format=png]
+....
+include::${pumlPath}[]
+...." >${tempAdocFile}
+        asciidoctor -r asciidoctor-diagram -o ../puml/$newFileName ../../docs_sources/${name}.adoc
+        rm ../../docs_sources/${name}.adoc
+    fi
+
+done
+
+# cleanup temp files
+if [ -d "../puml" ]; then
+    rm -r ../puml
+fi
+
+# STAGE_2 this creates new adoc files in /docs/resources
+
+for filename in $(find ../../docs_sources -name '*.adoc'); do
+    newFileName=${filename//-source/}
+    newFileName=${newFileName//_sources/}
+    asciidoctor-reducer $filename -o $newFileName
+done
+
+# Echo that the process is finished
+echo "Finished building source files"