Skip to content

Conversation

@TimInTech
Copy link
Owner

@TimInTech TimInTech commented Oct 3, 2025

Zusammenfassung von Sourcery

Restrukturiert und bereinigt das gesamte Projekt durch Refactoring des Ein-Klick-Installers und der Dienststartlogik, Modernisierung und Vereinfachung des API- und Schema-Codes, Überarbeitung der Dokumentation und Straffung der Tests bei gleichzeitiger Entfernung von totem Code.

Verbesserungen:

  • Refactoring und Vereinfachung des Installer-Skripts mit konsolidierter Protokollierung, Systemprüfungen, Portprüfungen und systemd-resolved-Handhabung
  • Optimierung der systemd-Dienstkonfiguration und Startlogik der Python-Suite in start_suite.py
  • Bereinigung der API-Implementierung und Pydantic-Schemas durch Entfernen von Duplikaten und Modernisierung von Validatoren
  • Entfernung veralteter Codepfade in dns_monitor.py, shared/db.py, shared_config.py und bootstrap/healthcheck-Skripten

Dokumentation:

  • Vollständige Überarbeitung der README (und README.de.md) mit Badges, Architekturdiagramm, Quickstart, API-Referenz, Fehlerbehebung und Sicherheitshinweisen

Tests:

  • Konsolidierung und Erweiterung von test_api.py mit vereinheitlichten Fixtures, Root-Endpoint- und Versionsprüfungen sowie Entfernung veralteter Tests
Original summary in English

Zusammenfassung von Sourcery

Überarbeitung des deutschen README mit konsistenter Markdown-Formatierung, Beispielen und aktualisierter Befehlsnutzung, sowie Optimierung von install.sh durch Entfernen ungenutzter Variablen, Verbesserung der Formatierung, Hinzufügen der systemd-resolved-Handhabung und eines Hinweises zur DoT-Weiterleitung.

Verbesserungen:

  • Aufruf von handle_systemd_resolved in install.sh und Hinzufügen eines Hinweises zur DoT-Weiterleitung in der Unbound-Konfiguration
  • Entfernen ungenutzter Variablen und Optimierung der Formatierung des apt-get install Befehls in install.sh

Dokumentation:

  • Standardisierung von Interpunktion, Tabellen und Listen in README.de.md
  • Hinzufügen eines Beispiels für den /leases-Endpunkt und Aktualisierung der Nutzung des API-Schlüssel-Headers in der API-Referenz

Wartungsarbeiten:

  • Bereinigung von Leerzeilen und kleineren Formatierungen im Installer-Skript
Original summary in English

Summary by Sourcery

Refine the German README with consistent markdown formatting, examples, and updated command usage, and streamline install.sh by removing unused variables, polishing formatting, and adding systemd-resolved handling and a DoT forwarding note.

Enhancements:

  • Invoke handle_systemd_resolved in install.sh and add a note on DoT forwarding in the Unbound config
  • Remove unused variables and streamline the apt-get install command formatting in install.sh

Documentation:

  • Standardize punctuation, tables, and lists in README.de.md
  • Add a /leases endpoint example and update API key header usage in the API reference

Chores:

  • Tidy blank lines and minor formatting in the installer script

@sourcery-ai
Copy link

sourcery-ai bot commented Oct 3, 2025

Leitfaden für Reviewer

Dieser PR verbessert die Dokumentationskonsistenz in der deutschen README-Datei und verfeinert das Installationsskript, indem ungenutzte Variablen entfernt, die Formatierung verbessert und die korrekte Handhabung von systemd-resolved sichergestellt wird.

Änderungen auf Dateiebene

Änderung Details Dateien
Standardisierung und Korrektur der Markdown-Formatierung in README.de.md
  • Konvertierung von Bindestrichen zu Halbgeviertstrichen in der Feature-Liste
  • Behebung von Code-Fence-Begrenzern und Hinzufügen fehlender Leerzeilen
  • Ausrichtung und Aktualisierung von Tabellen und Listenelementen für bessere Lesbarkeit
  • Verbesserung der API-Referenz mit konsistenten Überschriften und Beispielen
README.de.md
Straffung von install.sh durch Entfernung von totem Code und Verbesserung des Setup-Flows
  • Entfernung ungenutzter readonly-Variablen und Bildreferenz
  • Neuformatierung des Paketinstallationsbefehls und Hinzufügen von Leerzeilen zwischen Funktionen
  • Hinzufügen des Aufrufs des systemd-resolved-Handlers
  • Kommentierung der DoT-Weiterleitung und Bereinigung von Kommentaren
install.sh

Tipps und Befehle

Interaktion mit Sourcery

  • Einen neuen Review auslösen: Kommentieren Sie @sourcery-ai review im Pull Request.
  • Diskussionen fortsetzen: Antworten Sie direkt auf Sourcerys Review-Kommentare.
  • Ein GitHub-Issue aus einem Review-Kommentar generieren: Bitten Sie Sourcery, ein Issue aus einem Review-Kommentar zu erstellen, indem Sie darauf antworten. Sie können auch auf einen Review-Kommentar mit @sourcery-ai issue antworten, um ein Issue daraus zu erstellen.
  • Einen Pull Request-Titel generieren: Schreiben Sie @sourcery-ai irgendwo in den Pull Request-Titel, um jederzeit einen Titel zu generieren. Sie können auch @sourcery-ai title im Pull Request kommentieren, um den Titel jederzeit (neu) zu generieren.
  • Eine Pull Request-Zusammenfassung generieren: Schreiben Sie @sourcery-ai summary irgendwo in den Pull Request-Text, um jederzeit eine PR-Zusammenfassung genau dort zu generieren, wo Sie sie haben möchten. Sie können auch @sourcery-ai summary im Pull Request kommentieren, um die Zusammenfassung jederzeit (neu) zu generieren.
  • Einen Reviewer's Guide generieren: Kommentieren Sie @sourcery-ai guide im Pull Request, um den Reviewer's Guide jederzeit (neu) zu generieren.
  • Alle Sourcery-Kommentare auflösen: Kommentieren Sie @sourcery-ai resolve im Pull Request, um alle Sourcery-Kommentare aufzulösen. Nützlich, wenn Sie bereits alle Kommentare bearbeitet haben und sie nicht mehr sehen möchten.
  • Alle Sourcery-Reviews verwerfen: Kommentieren Sie @sourcery-ai dismiss im Pull Request, um alle bestehenden Sourcery-Reviews zu verwerfen. Besonders nützlich, wenn Sie mit einem neuen Review von vorne beginnen möchten – vergessen Sie nicht, @sourcery-ai review zu kommentieren, um einen neuen Review auszulösen!

Ihr Erlebnis anpassen

Greifen Sie auf Ihr Dashboard zu, um:

  • Review-Funktionen wie die von Sourcery generierte Pull Request-Zusammenfassung, den Reviewer's Guide und andere zu aktivieren oder zu deaktivieren.
  • Die Review-Sprache zu ändern.
  • Benutzerdefinierte Review-Anweisungen hinzuzufügen, zu entfernen oder zu bearbeiten.
  • Andere Review-Einstellungen anzupassen.

Hilfe erhalten

Original review guide in English

Reviewer's Guide

This PR enhances documentation consistency in the German README and refines the installer script by removing unused variables, improving formatting, and ensuring proper systemd-resolved handling.

File-Level Changes

Change Details Files
Standardize and correct Markdown formatting in README.de.md
  • Convert hyphens to en dashes in feature list
  • Fix code fence delimiters and add missing blank lines
  • Align and update tables and list items for readability
  • Enhance API reference with consistent headers and examples
README.de.md
Streamline install.sh by removing dead code and improving setup flow
  • Remove unused readonly variables and image reference
  • Reformat package installation command and add blank lines between functions
  • Add invocation of systemd-resolved handler
  • Annotate DoT forwarding and clean up comments
install.sh

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hallo! Ich habe deine Änderungen überprüft – hier ist etwas Feedback:

  • Der apt-get install-Block in install.sh hat sein apt-get install -y-Präfix nach dem Zeilenumbruch verloren und wird die benötigten Pakete stillschweigend nicht installieren.
  • Du hast die Standard-SUITE_API_KEY-Generierung entfernt, wodurch der Installer eine extern gesetzte Umgebungsvariable erfordert – führe entweder den Fallback wieder ein oder aktualisiere die README, um darauf hinzuweisen.
  • Überprüfe noch einmal, ob die neue Funktion handle_systemd_resolved früher im Skript definiert ist und das Deaktivieren von systemd-resolved korrekt handhabt, bevor Pi-hole startet.
Prompt für KI-Agenten
Bitte beachte die Kommentare aus dieser Code-Überprüfung:

## Allgemeine Kommentare
- Der `apt-get install`-Block in install.sh hat sein `apt-get install -y`-Präfix nach dem Zeilenumbruch verloren und wird die benötigten Pakete stillschweigend nicht installieren.
- Du hast die Standard-SUITE_API_KEY-Generierung entfernt, wodurch der Installer eine extern gesetzte Umgebungsvariable erfordert – führe entweder den Fallback wieder ein oder aktualisiere die README, um darauf hinzuweisen.
- Überprüfe noch einmal, ob die neue Funktion `handle_systemd_resolved` früher im Skript definiert ist und das Deaktivieren von systemd-resolved korrekt handhabt, bevor Pi-hole startet.

Sourcery ist kostenlos für Open Source – wenn dir unsere Überprüfungen gefallen, ziehe bitte in Betracht, sie zu teilen ✨
Hilf mir, nützlicher zu sein! Bitte klicke 👍 oder 👎 bei jedem Kommentar, und ich werde das Feedback nutzen, um deine Überprüfungen zu verbessern.
Original comment in English

Hey there - I've reviewed your changes - here's some feedback:

  • The apt-get install block in install.sh lost its apt-get install -y prefix after the line break and will silently fail to install the needed packages.
  • You removed the default SUITE_API_KEY generation, making the installer require an externally set env var—either reintroduce the fallback or update the README to call this out.
  • Double-check that the new handle_systemd_resolved function is defined earlier in the script and correctly handles disabling systemd-resolved before Pi-hole starts.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The apt-get install block in install.sh lost its `apt-get install -y` prefix after the line break and will silently fail to install the needed packages.
- You removed the default SUITE_API_KEY generation, making the installer require an externally set env var—either reintroduce the fallback or update the README to call this out.
- Double-check that the new `handle_systemd_resolved` function is defined earlier in the script and correctly handles disabling systemd-resolved before Pi-hole starts.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@TimInTech TimInTech closed this Oct 3, 2025
@TimInTech TimInTech deleted the fix/installer-tests-readme branch October 3, 2025 03:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants