Add uml file

Update ldes-vocabulary-build.yml to render plantuml svg
Update vocabulary.bs add UML

Author: ValyVanDenBroeck

.github/workflows/ldes-specification-build.yml

@@ -67,4 +67,4 @@ jobs:
             git push
           else
             echo "No changes to commit."
-          fi
+          fi

.github/workflows/ldes-vocabulary-build.yml

@@ -13,9 +13,47 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
 
     steps:
       - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Install GraphViz
+        run: sudo apt-get update && sudo apt-get install -y graphviz
+
+      - name: Download PlantUML jar
+        run: curl -L -o plantuml.jar https://github.com/plantuml/plantuml/releases/download/v1.2024.7/plantuml-1.2024.7.jar
+
+      # Optionally check the SHA256 checksum to avoid corrupt downloads
+      # - name: Verify PlantUML jar checksum
+      #   run: echo "<expected_sha256_here>  plantuml.jar" | sha256sum -c -
+
+      - name: Render .puml to .svg
+        run: |
+          find . -name '*.puml' -exec java -jar plantuml.jar -tsvg -o . {} +
+
+      - name: Commit rendered diagrams
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git add *.svg
+
+          if git diff --cached --quiet; then
+            echo "No diagram changes to commit."
+          else
+            git commit -m "auto-rendered PlantUML diagrams"
+            git push
+          fi
+          rm -f plantuml.jar || true
 
       - name: Publish Bikeshed document
         uses: w3c/spec-prod@v2
@@ -61,4 +99,4 @@ jobs:
             git push
           else
             echo "No changes to commit."
-          fi
+          fi

uml.puml

@@ -0,0 +1,69 @@
+@startuml
+ 
+' ===================
+' Classes and Attributes
+' ===================
+ 
+class "tree::Relation" {
+ + tree:path
+ + tree:remainingItems : int
+ + tree:value
+}
+ 
+class "tree::Node" {
+ + ldes:immutable : boolean
+ + ldes:viewDescription
+}
+ 
+class "tree::Collection" {
+ + tree:member
+}
+ 
+class "sh::NodeShape"
+ 
+class "dcat::Distribution"
+ 
+class "hydra::IriTemplate"
+ 
+class "ldes::RetentionPolicy" {
+ + ldes:fullLogDuration
+ + ldes:startingFrom : dateTime
+ + ldes:versionAmount
+ + ldes:versionDeleteDuration : duration
+ + ldes:versionDuration : duration
+}
+ 
+class "ldes::EventStream" {
+ + ldes:pollingInterval : int
+ + ldes:sequencePath
+ + ldes:timestampPath
+ + ldes:versionOfPath
+ + ldes:versionSequencePath
+ + ldes:versionTimestampPath
+}
+ 
+class "ldes::EventSource" {
+ + ldes:transactionFinalizedObject
+ + ldes:transactionFinalizedPath
+ + ldes:transactionPath
+ + ldes:versionCreateObject
+ + ldes:versionCreatePath
+ + ldes:versionDeleteObject
+ + ldes:versionDeletePath
+ + ldes:versionUpdateObject
+ + ldes:versionUpdatePath
+}
+ 
+' ===================
+' Relationships
+' ===================
+ 
+"tree::Relation" --> "tree::Node" : tree:node
+"tree::Node" --> "tree::Collection" : tree:view
+"tree::Collection" --> "tree::Node" : tree:shape
+"dcat::Distribution" <|-- "ldes::EventSource"
+"ldes::EventSource" --> "ldes::EventStream" : tree:viewDescription
+"ldes::EventStream" --> "ldes::RetentionPolicy" : ldes:retentionPolicy
+"tree::Relation" --> "hydra::IriTemplate" : hydra:iriTemplate
+ 
+@enduml

vocabulary.bs

@@ -16,6 +16,11 @@ This specification introduces terms used to describe event streams.
 While these terms can be used independently of the LDES specification,
 the main LDES specification is available at [https://w3id.org/ldes/specification](https://w3id.org/ldes/specification).
 
+<figure id="fig-ldes-model">
+ <img src="uml.svg" alt="LDES model diagram">
+ <figcaption>LDES model diagram (<a href="uml.puml">source</a>)</figcaption>
+</figure>
+
 # Terms # {#terms}
 
 This document introduces terms in the namespace `https://w3id.org/ldes#` with the preferred prefix `ldes:`.