inline plz bot

Inline-plz-Bot

Webdienstversion von https://github.com/guykisel/inline-plz - FININTS Ihre Pull -Anfragen und Kommentare Inline auf den Diffs!

Wie benutze ich das?

1. Einstellungen -> Webhooks -> Webhook hinzufügen
2. Nutzlast -URL: https://inlineplz.herokuapp.com/
3. Lassen Sie mich einzelne Ereignisse auswählen: Wählen Sie die Anfrage an

Warum möchte ich das verwenden?

Wenn Sie statische Analysen mit Ihren Pull -Anfragen verwenden, haben Sie sich wahrscheinlich an diesen Workflow gewöhnt:

1. Führen Sie die statische Analyse lokal aus, beheben Sie Probleme
2. Einen Zweig hochschieben
3. Öffnen Sie eine PR
4. Warten Sie, bis der PR in Ihrem CI -Tool passt
5. Holen Sie sich ein wenig rotes X auf Ihre PR, weil Sie vergessen haben, eines der statischen Analyse -Tools auszuführen
6. Klicken Sie auf das Little Red X, kriechen Sie durch Konsolenprotokolle und finden Sie schließlich eine kryptische Nachricht, die auf eine bestimmte Zeile in einem Ihrer Dateien verweist
7. Gehen Sie zurück zu Ihrem Code, suchen Sie die richtige Datei und Zeile nach und kehren Sie dann zur Fehlermeldung zurück, da Sie bereits vergessen haben, was sie war

Dieser Bot gibt Ihnen die statische Analyseausgabe, die direkt in Ihre PR -Diffs eingebaut ist, sodass Sie Fehler effizienter verstehen können.

Wie funktioniert es

1. Dieses Repo enthält einen einfachen kleinen Flask -Server, der für GitHub Webhooks hört
2. Wenn jemand eine Pull -Anfrage eröffnet oder einige neue Commits hochschiebt, gibt die Webhook -Beiträge des Repos zum Flask -Server veröffentlicht
3. Der Flask-Server liest die Github-PR-Daten (Zweig, SHA usw.), kloniert das Repo und schült sich auf Inline-PLZ aus
4. Inline-PLZ führt statische Analyse-Tools aus und verwendet die Github-API, um die PR mit allen Fehlern zu kommentieren, die sie findet

Das ist cool, wie kann ich dazu beitragen

• Melden Sie Fehler und Feature -Anfragen!
  • Probleme für den WebService/Bot sollten in diesem Repo (inline-plz-bot) gehen
  • Probleme für die Kernfunktionalität von Inline-PLZ sollten unter https://github.com/guykisel/inline-plz gehen
• Fügen Sie Unterstützung für statischere Analyse -Tools hinzu
• Fügen Sie Unterstützung für andere Code -Überprüfungs -Tools neben nur Github hinzu
• Dokumentation hinzufügen
• Unit -Tests hinzufügen
• Fehler beheben