automate UML diagrams

.github/workflows/uml.yml

@@ -0,0 +1,53 @@
+name: Update the UML Diagrams
+
+permissions: write-all
+
+on:
+  pull_request:
+    branches: [main]
+    # paths:
+    #   - "causalpy/**"
+  push:
+    branches: [main]
+    # paths:
+    #   - "causalpy/**"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref || 'main' }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+
+      - name: Configure Git Identity
+        run: |
+          git config user.name "$(git log -n 1 --pretty=format:%an)"
+          git config user.email "$(git log -n 1 --pretty=format:%ae)"
+
+      - name: Update the UML Diagrams
+        run: |
+          sudo apt-get update && sudo apt-get install -y graphviz
+          pip install --upgrade pip && pip install ".[docs]"
+          make uml
+
+      - name: Push up the changes
+        run: |
+          git add docs/source/_static/*.png
+          if git diff --staged --exit-code; then
+            echo "No changes to commit"
+          else
+            echo "Committing the changes"
+            echo ${GITHUB_HEAD_REF}
+            git commit -m "Update UML Diagrams"
+            git push origin HEAD:${GITHUB_HEAD_REF}
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

pyproject.toml

@@ -67,6 +67,7 @@ docs = [
     "sphinx-notfound-page",
     "ipywidgets",
     "sphinx-design",
+    "pylint",
 ]
 lint = ["interrogate", "pre-commit", "ruff"]
 test = ["pytest", "pytest-cov"]