Library workflow refactor (#3928)

Co-authored-by: Andrew Jackson <[email protected]>

Author: EVWorth

.github/FUNDING.yml .github/FUNDING.yaml.github/FUNDING.yml renamed to .github/FUNDING.yaml

@@ -12,4 +12,6 @@ updates:
       interval: "weekly"
     ignore:
       # Dependabot should not update Home Assistant as that should match the homeassistant key in hacs.json
-      - dependency-name: "homeassistant"
+      - dependency-name: "homeassistant"
+      - dependency-name: "mkdocs-material"
+      - dependency-name: "pytablewriter"

.github/ISSUE_TEMPLATE/bug.yml .github/ISSUE_TEMPLATE/bug.yaml.github/ISSUE_TEMPLATE/bug.yml renamed to .github/ISSUE_TEMPLATE/bug.yaml

@@ -1,39 +1,43 @@
 """Battery library document generator."""
 
-from __future__ import annotations
-
 import json
 
 from pytablewriter import MarkdownTableWriter
 
 
-def generate_device_list():
-    """Generate static file containing the device library."""
-
+def get_device_list() -> None:
+    """Sort the device library JSON file."""
     # Load the existing JSON library file
     with open(
-        "library/library.json", encoding="UTF-8"
+        file="library/library.json",
+        encoding="UTF-8",
     ) as f:
         devices_json = json.loads(f.read())
         devices = devices_json.get("devices")
 
-    toc_links: list[str] = []
-    tables_output: str = ""
-    rows = []
-
-    num_devices = len(devices)
-
-    writer = MarkdownTableWriter()
-    headers = [
-        "Manufacturer",
-        "Model",
-        "Battery Type",
-        "Model ID (optional)",
-        "HW Version (optional)",
-    ]
+    # Sort the devices by manufacturer and model
+    devices.sort(
+        key=lambda k: (
+            k["manufacturer"].lower(),
+            k.get("model_match_method", "").lower(),
+            k["model"].lower(),
+            k.get("model_id", "").lower(),
+            k.get("hw_version", "").lower(),
+        )
+    )
+    with open("library/library.json", "w", encoding="UTF-8") as f:
+        f.write(json.dumps(devices_json, indent=4))
+
+
+def regenerate_device_list() -> None:
+    """Generate static file containing the device library."""
 
-    writer.header_list = headers
+    # Load the existing JSON library file
+    with open("library/library.json", encoding="UTF-8") as file:
+        devices_json = json.loads(file.read())
+        devices = devices_json.get("devices")
 
+    rows = []
     for device in devices:
         if device.get("battery_quantity", 1) > 1:
             battery_type_qty = f"{device['battery_quantity']}× {device['battery_type']}"
@@ -58,15 +62,28 @@ def generate_device_list():
         ]
         rows.append(row)
 
+    writer = MarkdownTableWriter()
+    writer.header_list = [
+        "Manufacturer",
+        "Model",
+        "Battery Type",
+        "Model ID (optional)",
+        "HW Version (optional)",
+    ]
     writer.value_matrix = rows
-    tables_output += f"## {num_devices} Devices in library\n\n"
-    tables_output += "This file is auto generated, do not modify\n\n"
-    tables_output += "Request new devices to be added to the library [here](https://github.com/andrew-codechimp/HA-Battery-Notes/issues/new?template=new_device_request.yml&title=%5BDevice%5D%3A+)\n\n"
-    tables_output += writer.dumps()
+
+    tables_output = [f"## {len(devices)} Devices in library\n\n"]
+    tables_output.append("This file is auto generated, do not modify\n\n")
+    tables_output.append(
+        "Request new devices to be added to the library [here](https://github.com/andrew-codechimp/HA-Battery-Notes/issues/new?template=new_device_request.yml&title=%5BDevice%5D%3A+)\n\n"
+    )
+    tables_output.append(writer.dumps())
 
     with open("library.md", "w", encoding="UTF-8") as md_file:
-        md_file.write("".join(toc_links) + tables_output)
+        md_file.write("".join(tables_output))
         md_file.close()
 
 
-generate_device_list()
+if __name__ == "__main__":
+    get_device_list()
+    regenerate_device_list()

.github/ISSUE_TEMPLATE/config.yml .github/ISSUE_TEMPLATE/config.yaml.github/ISSUE_TEMPLATE/config.yml renamed to .github/ISSUE_TEMPLATE/config.yaml

@@ -0,0 +1,31 @@
+name: Deploy docs
+on:
+  push:
+    paths:
+      - 'mkdocs.yaml'
+      - 'docs/**'
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy_docs:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ runner.os }}-${{ hashFiles('mkdocs.yaml', 'pyproject.toml', 'uv.lock') }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Deploy documentation
+        run: |
+          uv run --only-group docs mkdocs gh-deploy --force