From 78f783cfad5aedd22948aa2428c0a23faa2b8590 Mon Sep 17 00:00:00 2001 From: dev_agent <17+dev_agent@code.cubecraftcreations.com> Date: Sun, 13 Sep 2026 15:01:09 -0400 Subject: [PATCH] docs: point HACS installation at the public GitHub mirror (#6) --- README.md | 6 +++++- tests/test_hacs.py | 10 ++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6083a8e..55aea77 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,15 @@ NestQuest helps households coordinate daily life, chore tracking, custody schedu 1. Ensure [HACS (Home Assistant Community Store)](https://hacs.xyz/) is installed. 2. In Home Assistant, open **HACS** > **Integrations**. 3. Select the three-dots menu in the top right and click **Custom repositories**. -4. Enter the repository URL: `https://code.cubecraftlabs.com/Maniacs_Mansion/NestQuest` +4. Enter the repository URL: `https://github.com/talon2king/NestQuest` 5. Select category **Integration** and click **Add**. 6. Search for **NestQuest** and click **Download**. 7. Restart Home Assistant. +> **Note:** Development happens in the private Gitea repository +> (`https://code.cubecraftlabs.com/Maniacs_Mansion/NestQuest`). The GitHub +> repository is a public mirror maintained for HACS distribution. + ### Manual Installation 1. Download the latest release from the repository. diff --git a/tests/test_hacs.py b/tests/test_hacs.py index 41eeb74..473d0c5 100644 --- a/tests/test_hacs.py +++ b/tests/test_hacs.py @@ -58,6 +58,16 @@ def test_readme_exists_and_contains_required_sections() -> None: assert "uv run pytest" in content +def test_readme_hacs_points_at_public_github_mirror() -> None: + """Verify README directs HACS users to the public GitHub mirror, not the private Gitea repo.""" + content = README_PATH.read_text(encoding="utf-8") + assert "https://github.com/talon2king/NestQuest" in content + assert "https://code.cubecraftlabs.com/Maniacs_Mansion/NestQuest" in content + assert content.index("https://github.com/talon2king/NestQuest") < content.index( + "https://code.cubecraftlabs.com/Maniacs_Mansion/NestQuest" + ) + + def test_hacs_directory_structure() -> None: """Verify directory structure matches HACS integration expectations.""" assert MANIFEST_PATH.exists(), f"Integration manifest does not exist at {MANIFEST_PATH}"