[REOPEN] ALFMOB-178 | Project Documentation

.github/workflows/diagrams.yml

@@ -6,56 +6,55 @@ permissions:
 on:
   push:
     branches: [main]
-  pull_request:
   workflow_dispatch:
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    
+
     steps:
-    - name: Get the code from the repository
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0 
-
-    - name: Create error logs directory
-      run: mkdir -p error-logs
-
-    - name: Set up JDK 21
-      uses: actions/setup-java@v4
-      with:
-        java-version: '21'
-        distribution: 'temurin'
-
-    - name: Set execute permissions on build scripts
-      run: chmod +x tools/generate/generate-plantuml-diagrams.sh || true
-
-    - name: Debug script presence
-      run: |
-        ls -l tools/generate/
-        file tools/generate/generate-plantuml-diagrams.sh
-        head -5 tools/generate/generate-plantuml-diagrams.sh
-
-    - name: Install Graphviz
-      run: sudo apt-get install -y graphviz
-
-    - name: Set up Git user
-      run: |
-        git config --global user.name "github-actions[bot]"
-        git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
-
-    - name: Update .svg
-      run: ./tools/generate/generate-plantuml-diagrams.sh
-      
-    - name: Add SVG files
-      run: git add *.svg
-
-    - name: Commit and push if there are changes
-      run: |
-        if ! git diff --cached --quiet; then
-          git commit -m "Update diagrams"
-          git push origin HEAD:main
-        else
-          echo "No changes to SVG files"
-        fi
+      - name: Get the code from the repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Create error logs directory
+        run: mkdir -p error-logs
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: "21"
+          distribution: "temurin"
+
+      - name: Set execute permissions on build scripts
+        run: chmod +x tools/generate/generate-plantuml-diagrams.sh || true
+
+      - name: Debug script presence
+        run: |
+          ls -l tools/generate/
+          file tools/generate/generate-plantuml-diagrams.sh
+          head -5 tools/generate/generate-plantuml-diagrams.sh
+
+      - name: Install Graphviz
+        run: sudo apt-get install -y graphviz
+
+      - name: Set up Git user
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+      - name: Update .svg
+        run: ./tools/generate/generate-plantuml-diagrams.sh
+
+      - name: Add SVG files
+        run: git add *.svg
+
+      - name: Commit and push if there are changes
+        run: |
+          if ! git diff --cached --quiet; then
+            git commit -m "Update diagrams"
+            git push origin main
+          else
+            echo "No changes to SVG files"
+          fi

docs/global-artifacts/01.requirements-engineering/puml/use-case-diagram.puml

@@ -1,13 +1,13 @@
-@startuml Use Case Diagram for Melmac Performance Testing Framework
+@startuml use-case-diagram
 left to right direction
 
 actor "Developer or CI/CD Pipeline" as Dev
 
 rectangle "Melmac Performance Testing Framework" {
-    usecase "UC1: Create Test Suite" as UC1
-    usecase "UC2: Create Test Plan" as UC2
-    usecase "UC3: Run Test Suite" as UC3
-    usecase "UC4: Run Test Plan" as UC4
+    usecase "UC1: As a Developer, I want to create a Test Suite" as UC1
+    usecase "UC2: As a Developer, I want to create a Test Plan" as UC2
+    usecase "UC3: As a Developer, I want to run a Test Suite" as UC3
+    usecase "UC4: As a Developer, I want to run a Test Plan" as UC4
 }
 
 Dev --> UC1

docs/global-artifacts/03.design/implementation-view/level-2/drawio/L2-IV.drawio

@@ -15,10 +15,10 @@
                         <Array as="points"/>
                     </mxGeometry>
                 </mxCell>
-                <mxCell id="3" value="MelmacBE" style="shape=folder;fontStyle=1;spacingTop=10;tabWidth=40;tabHeight=14;tabPosition=left;html=1;whiteSpace=wrap;verticalAlign=top;" parent="1" vertex="1">
+                <mxCell id="3" value="MelmacBE" style="shape=folder;fontStyle=1;spacingTop=10;tabWidth=40;tabHeight=14;tabPosition=left;html=1;whiteSpace=wrap;verticalAlign=top;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
                     <mxGeometry x="230" y="200" width="150" height="140" as="geometry"/>
                 </mxCell>
-                <mxCell id="5" value="DriverRunner (iOS)" style="shape=folder;fontStyle=1;spacingTop=10;tabWidth=40;tabHeight=14;tabPosition=left;html=1;whiteSpace=wrap;verticalAlign=top;" parent="1" vertex="1">
+                <mxCell id="5" value="DriverRunner (iOS)" style="shape=folder;fontStyle=1;spacingTop=10;tabWidth=40;tabHeight=14;tabPosition=left;html=1;whiteSpace=wrap;verticalAlign=top;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
                     <mxGeometry x="480" y="200" width="144" height="140" as="geometry"/>
                 </mxCell>
                 <mxCell id="18" value="Untitled Layer" parent="0"/>