Created a script to auto generate the uml diagrams and added a workfl…

…ow for it.
bardia-p · Nov 11, 2023 · 4528ba2 · 4528ba2
1 parent a3602b3
commit 4528ba2
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 2 deletions.
diff --git a/.github/workflows/diagrams.yml b/.github/workflows/diagrams.yml
@@ -0,0 +1,18 @@
+name: Generate Diagrams
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    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
diff --git a/diagrams/Milestone1_ER_Diagram.png b/diagrams/Milestone1_ER_Diagram.png
diff --git a/diagrams/Milestone1_UML_Class_Diagram.png b/diagrams/Milestone1_UML_Class_Diagram.png
diff --git a/diagrams/Milestone1_UML_class_diagram.png b/diagrams/Milestone1_UML_class_diagram.png
diff --git a/plantUmlFiles/ERDiagram.plantuml → diagrams/plantUmlFiles/ERDiagram.plantuml b/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

diff --git a/plantUmlFiles/UMLClassDiagram.plantuml → ...ms/plantUmlFiles/UMLClassDiagram.plantuml b/plantUmlFiles/UMLClassDiagram.plantuml → ...ms/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

diff --git a/generate_diagrams.sh b/generate_diagrams.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+
+input_directory="./diagrams/plantUmlFiles"
+
+plantuml="./tools/plantuml.jar"
+
+for file in "$input_directory"/*.plantuml; do
+    if [ -f "$file" ]; then
+        java -jar "$plantuml" "$file" -o "../"
+    fi
+done
diff --git a/tools/plantuml.jar b/tools/plantuml.jar