AutoPR
v0.2.0
Führen Sie AI-betriebene Workflows über Ihre Codebasis aus
? Lebende Zusammenfassungen Ihres Kodex in verschachtelten Readmes
Todos hat in Themen im Auge behalten
⏳ Halten Sie die Geschichte eines API -Aufrufergebnisses in Git auf
? Fassen Sie Änderungen zusammen, indem Sie einem PR ein "zusammenfassen" Etikett hinzufügen
? Benutzerdefinierte Aktionen in YAML konfiguriert
Bitte beachten Sie die Installationshandbuch.
Obwohl dieses Projekt intern verwendet wird, wird es derzeit nicht aktiv gewartet.
Bis V0.1.2 generierten Autops autonom autonom Pull -Anfragen von Problemen. Wenn Sie dafür noch bevorzugen, die folgende Zeile in Ihren GitHub -Aktionen YAML zu verwenden:
uses : docker://ghcr.io/irgolic/autopr:v0.1.2Im Folgenden finden Sie ein Beispiel für Autops Living Readme:
Dieser Ordner enthält verschiedene Dateien und Ordner, die sich auf die Automatisierung von Aufgaben und Workflows beziehen. It includes a Dockerfile for setting up a Docker image, a license file specifying the terms of use, a Makefile for automating development tasks, an action configuration file for a pull request workflow, a shell script for executing a Python module, a lock file and a configuration file for a Python project using Poetry, JSON schemas for defining strict workflows and trigger configurations, and a JSON schema for defining workflow Definitionen. Diese Dateien und Ordner bieten Funktionen für die Automatisierung von Aufgaben, das Verwalten von Aktionen und Git -Vorgängen und die Ausführung anpassbarer Workflows.
Dockerfile Richtet ein Docker-Bild basierend auf dem duffn/python-poetry:3.9-bullseye -Bild ein
? Installiert Git aus dem Bullseye-Backports-Repository
? Kopiert ein Einstiegspunkt -Skript und macht es ausführbar
? Kopiert die Dateien pyproject.toml und poetry.lock
? Aktiviert die virtuelle Umgebung und installiert die Projektabhängigkeiten mithilfe von Poesie
? Kopiert den Rest der Dateien in das Verzeichnis /app
? Installiert die Anwendung mit Poesie
Legt den Einstiegspunkt auf /entrypoint.sh zum Ausführen der App fest
LICENSE.md ? Diese Datei enthält die MIT -Lizenz.
Die Lizenz gewährt die Berechtigung zur Verwendung, Änderung und Verteile der Software.
Die Lizenz verlangt, dass die Bekanntmachung von Urheberrechten und Berechtigungen in alle Exemplare aufgenommen werden muss.
Die Software wird "wie ist" ohne Garantie bereitgestellt.
? Die Lizenz ist bis 2023 gültig.
Die Lizenz gehört Raphael Francis Ltd.
Makefile Diese Datei ist eine makefile-ähnliche Konfigurationsdatei.
? Es definiert verschiedene Ziele und ihre zugehörigen Befehle.
Die Ziele sind: format , type , test , schema und all .
? Das format führt einen Befehl zum Formatcode mithilfe des black Tools aus.
? Mit dem type -Ziel wird ein Befehl ausgeführt, um die Typ -Überprüfung mit pyright durchzuführen.
? Das test führt PyTest im autopr/tests -Verzeichnis aus.
? Das schema -Ziel führt einen Befehl aus, um Konfigurationseinstiegspunkte mit autopr.models.config zu generieren.
? Das all Ziel führt alle Ziele in Sequenz aus: format , type , test und schema .
? Diese Datei soll gemeinsame Entwicklungsaufgaben automatisieren und die Codequalität sicherstellen.
action.yml ? Diese Datei ist eine Konfigurationsdatei für einen automatischen Workflow für Pull -Anforderungen.
? Es gibt die Details zum Ausführen des Workflows an, z. B. das zu verwendende Docker -Bild.
? Es enthält auch Brandinginformationen wie das zu verwendende Symbol und die Farbe.
? Die Datei definiert Eingaben, die für den Workflow erforderlich sind, wie z. B. das Github -Token und den Basiszweig.
? Es enthält eine Standard -Lade -GIF -URL, die angezeigt wird, während die Pull -Anforderung generiert wird.
? Die Datei definiert eine Vorlage für den Namen der Zielzweig.
Es wird angegeben, ob vorhandene Zweige überschreiben und Anfragen abziehen sollen, wenn Sie aus Problemen erstellen.
autopr/Dieser Ordner enthält eine Sammlung von Python -Dateien und Ordnern, die sich auf die Automatisierung von Aufgaben und Workflows beziehen. Es enthält Dateien für Aktionen und Dienstprogramme, einen Einstiegspunkt für GitHub -Aktionen, Protokollierungskonfiguration, den Hauptdienst für Ausführen von Auslöser und Workflows, Modelle zum Erstellen und Ausführen von Workflows, Diensten für die Verwaltung von Aktionen und GIT -Operationen, Auslöserkonfigurationen sowie Skripts und Konfigurationsdateien für die Verwaltung von Workflows. Diese Dateien und Ordner bieten Funktionen für die Automatisierung von Aufgaben, die Interaktion mit der Github -Plattform und die Ausführung anpassbarer Workflows.
entrypoint.sh Die Datei ist ein Shell -Skript
? Es legt die GIT -Konfiguration für ein bestimmtes Verzeichnis fest
✉️ Es legt die Benutzer -E -Mail und den Namen für Git Commits fest
? Es aktiviert eine virtuelle Umgebung
? Es wird ein Python -Modul namens autopr.gh_actions_entrypoint ausgeführt
poetry.lock ? Diese Datei ist eine Executive -Zusammenfassung eines Projekts oder eines Berichts
? Es bietet einen hochrangigen Überblick über die Hauptpunkte
Es zeigt wichtige Erkenntnisse, Schlussfolgerungen und Empfehlungen
Es kann eine Zusammenfassung von Daten oder Analysen enthalten
Es ist für jemanden vorgesehen, der neu im Projekt oder Bericht ist
Es enthält keine trivialen Details oder technische Erklärungen
Es gibt ein klares Verständnis für den Zweck und den Umfang des Projekts
? Es gibt einen kurzen Blick auf den Inhalt, ohne in die Tiefe zu gehen
Es dient als Ausgangspunkt für weitere Erkundungen oder Diskussionen
? Es ist prägnant und leicht zu lesen, auch wenn die Datei leer ist
pyproject.toml ? Diese Datei ist eine Konfigurationsdatei für ein Python -Projekt unter Verwendung von Poesie.
? Es enthält Informationen über den Namen, die Version und die Autoren des Projekts.
? Die Lizenz des Projekts ist als MIT angegeben.
? Es listet die Pakete und ihre Abhängigkeiten auf, die für das Projekt erforderlich sind.
? Es gibt separate Abhängigkeiten für Tests und Entwicklung.
? Das verwendete Build -System ist Poesie.
? Die Datei enthält auch Konfiguration für den Pyright Static Type Checker.
? Es gibt die Zeilenlänge und die Zielversion für den Black Code -Formatierer an.
strict_workflow_schema.json ? Die Datei ist ein JSON -Schema, das eine strenge Workflow -Definition beschreibt.
? Es definiert verschiedene Aktionen, die im Workflow ausgeführt werden können.
? Zu den Aktionen gehören das Kommentieren, das Festlegen von Problemtiteln, das Wanderdateien, das Ausführen von API -Anrufen, das Ausführen von Bash -Befehlen und vieles mehr.
Jede Aktion hat ihre eigenen Eingänge und Ausgänge.
Die Workflow -Schritte werden als eine Reihe von Aktionen definiert.
Das Schema enthält auch Definitionen für verschiedene Datentypen und Deklarationen, die innerhalb der Aktionen verwendet werden.
Der Zweck der Datei besteht darin, eine standardisierte Struktur zur Definition und Ausführung strenger Workflows bereitzustellen.
Das Schema kann verwendet werden, um die Richtigkeit der Workflow -Definitionen zu validieren und sicherzustellen.
? Es ermöglicht eine einfache Integration in andere Tools und Systeme, die das Schema unterstützen.
Die Datei kann als Referenz für das Verständnis der Struktur und der Fähigkeiten strenger Workflows dienen.
trigger_schema.json ? Diese Datei ist ein JSON -Dokument, das eine Triggerkonfiguration für einen Workflow beschreibt.
? Es definiert verschiedene Triggertypen wie Etikett-, Kommentar-, Push- und Cron -Trigger.
? Euen jeder Triggertyp hat seine eigenen Eigenschaften und kann angepasst werden.
? Auslöser können verwendet werden, um bestimmte Aktionen oder Workflows basierend auf bestimmten Ereignissen zu initiieren.
Das Dokument enthält auch Definitionen für verschiedene Aktionsmodelle und deren Eigenschaften.
? Diese Aktionsmodelle können innerhalb der Trigger verwendet werden, um das gewünschte Verhalten anzugeben.
Die Datei bietet einen umfassenden Überblick über die verfügbaren Auslöser und Aktionsmodelle.
? Es kann als Referenzhandbuch zum Konfigurieren und Anpassen von Workflows verwendet werden.
Die Dateistruktur wird mit verschachtelten Objekten und Eigenschaften organisiert.
? Es ist wichtig, die spezifischen Auslöser- und Aktionsdefinitionen zu überprüfen, um ihre Funktionalität und Verwendung zu verstehen.
workflow_schema.json ? Diese Datei ist eine JSON -Schema -Definition für eine Workflow -Definition.
? Es definiert verschiedene Arten und Eigenschaften für verschiedene Aktionen und Erklärungen, die im Workflow verwendet werden.
Das Schema enthält Definitionen für Aktionen wie das Kommentieren, das Festlegen von Problemen, Wanderdateien, das Ausführen von API -Anrufen, das Ausführen von Bash -Befehlen usw.
Es definiert auch verschiedene Arten von Deklarationen wie Vorlage, Variable, Konstant und Lambda -Deklarationen.
? Die Workflow -Definition enthält einen Namen, eine Beschreibung, Eingänge und Ausgänge.
? Es besteht aus einer Liste von Schritten, die Aktionen, Workflow -Aufrufe oder bedingte Aussagen sein können.
? Bedingte Aussagen können IF-ELSE-Zweige haben und verschiedene Bedingungen wie Lambda-Ausdrücke und Kontextüberprüfungen unterstützen.
Workflow -Aufrufe können entweder regelmäßig oder iterbar sein.
? Insgesamt bietet diese Datei eine strukturierte Definition für das Erstellen und Ausführen von Workflows mit verschiedenen Aktionen und Bedingungen.
