Update issues & workflow

Author: andrew-codechimp

.github/ISSUE_TEMPLATE/new_device_request.yml

@@ -6,7 +6,7 @@ body:
   - type: markdown
     attributes:
       value: |
-        The battery library is a JSON document at [custom_components/battery_notes/data/library.json](https://github.com/andrew-codechimp/HA-Battery-Notes/blob/main/custom_components/battery_notes/data/library.json)
+        The battery library is a JSON document at [library/library.json](https://github.com/andrew-codechimp/HA-Battery-Notes/blob/main/library/library.json)
         To contribute, submit your device details via this form and the relevant code changes will be proposed on your behalf.
 
         If you add a device manually in Battery Notes you will be able to see the details required at the top of the battery details panel, which is also available in the configure panel for the device within the Battery Notes integration once you have added it.

.github/scripts/library_doc/generate_file.py

@@ -12,7 +12,7 @@ def generate_device_list():
 
     # Load the existing JSON library file
     with open(
-        "custom_components/battery_notes/data/library.json", encoding="UTF-8"
+        "library/library.json", encoding="UTF-8"
     ) as f:
         devices_json = json.loads(f.read())
         devices = devices_json.get("devices")

.github/workflows/json_librarian.yml

@@ -32,13 +32,13 @@ jobs:
             import json
 
             # Load the existing JSON library file
-            with open("custom_components/battery_notes/data/library.json", "r", encoding="UTF-8") as f:
+            with open("library/library.json", "r", encoding="UTF-8") as f:
                 devices_json = json.loads(f.read())
                 devices = devices_json.get("devices")
 
             # 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("custom_components/battery_notes/data/library.json", "w", encoding="UTF-8") as f:
+            with open("library/library.json", "w", encoding="UTF-8") as f:
                 f.write(json.dumps(devices_json, indent=4))
 
       - name: Install library doc generator dependencies

.gitignore

@@ -15,7 +15,6 @@ coverage.xml
 config/*
 !config/configuration.yaml
 .DS_Store
-custom_components/battery_notes/data/library-dev.json
 config/configuration.yaml
 
 custom_components/battery_notes/frontend/node_modules

docs/library.md

@@ -14,7 +14,7 @@ Upon submission using the form above GitHub will attempt to make the required co
 
 ## Submit Definition via Pull Request
 
-Fork the repository, add your device details to the JSON document `custom_components/battery_notes/data/library.json`, and then submit a pull request. Do not enable GitHub Actions (disabled by default) as this will mess with the pull request and are unnecessary for a library submission.
+Fork the repository, add your device details to the JSON document `library/library.json`, and then submit a pull request. Do not enable GitHub Actions (disabled by default) as this will mess with the pull request and are unnecessary for a library submission.
 
 * The easiest way to get the correct device information is to add the device manually, on the battery type panel you will see a summary at the top of the details required to add to the library.  This is also available if you go into configure of the device in battery notes.
 * The manufacturer and model should be exactly what is displayed on the Device screen within Home Assistant. If the Device screen has a Model ID or Hardware Version then this should be included.