Closing #34 Created a script to auto generate the uml and ER diagrams

.github/workflows/diagrams.yml

@@ -0,0 +1,20 @@
+name: Generate Diagrams
+
+on:
+  push:
+    paths: [ '**.plantuml' ]
+    branches: [ "main" ]
+  pull_request:
+    paths: [ '**.plantuml' ]
+    branches: [ "main" ]
+
+jobs:
+  run_tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run ./generate_diagrams.sh
+        run: |
+          chmod +x ./generate_diagrams.sh
+          ./generate_diagrams.sh
+        shell: bash

plantUmlFiles/ERDiagram.plantuml → diagrams/plantUmlFiles/ERDiagram.plantuml

@@ -1,4 +1,9 @@
-@startuml
+@startuml Milestone1_ER_Diagram
+skinparam classFontSize 11
+skinparam classBackgroundColor beige
+skinparam ClassBorderColor red
+skinparam ArrowColor red
+
 entity "Answer" as answer {
   *id : Long
   *content : String

plantUmlFiles/UMLClassDiagram.plantuml → diagrams/plantUmlFiles/UMLClassDiagram.plantuml

@@ -1,4 +1,4 @@
-@startuml Milestone1_UML_class_diagram
+@startuml Milestone1_UML_Class_Diagram
 skinparam classFontSize 11
 skinparam classBackgroundColor beige
 skinparam ClassBorderColor red

generate_diagrams.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+input_directory="./diagrams/plantUmlFiles"
+
+plantuml="./tools/plantuml.jar"
+
+if [ $(which dot 2>/dev/null) ]; then
+  echo "Found GraphViz"
+else
+  echo "Did not find GraphViz"
+  sudo apt install graphviz
+fi
+
+for file in "$input_directory"/*.plantuml; do
+    if [ -f "$file" ]; then
+      java -jar "$plantuml" "$file" -o "../"
+      if [ $? != 0 ]; then
+          raise error "Failed to generate the diagram"
+      fi
+    fi
+done
+
+echo "Successfully Generated the Diagrams"