AutoReviewer

? Automatisierte Codeüberprüfungen mit ChatGPT?

Eine GitHub-Aktion verwendet GPT-4 von OpenAI, um automatisierte Codeüberprüfungen durchzuführen. Wenn Sie eine PR erstellen, überprüft unsere Aktion automatisch den Code und schlägt Änderungen vor, genau wie es ein menschlicher Codeprüfer tun würde.

Wie man es benutzt

• Holen Sie sich einen API-Schlüssel von OpenAI
• Fügen Sie es als GitHub-Geheimnis hinzu
• Richten Sie eine Aktion ein, die bei jedem PR ausgeführt wird

 name : ' code-review '
on : # rebuild any PRs and main branch changes
  pull_request :
jobs :
  code-review :
    runs-on : ubuntu-latest
    permissions :
      contents : read
      pull-requests : write
    steps :
      - uses : actions/checkout@v3
      - uses : gvasilei/[email protected]
        env :
          NODE_OPTIONS : ' --experimental-fetch '
        with :
          github_token : ${{ secrets.GITHUB_TOKEN }}
          openai_api_key : ${{ secrets.OPENAI_API_KEY }}
          exclude_files : ' *.json, *.md, *.yml ' # optionally exclude files based on a wildcard expression. 

• Oder wenn ein Etikett hinzugefügt wird

 name : ' code-review '
on : # rebuild any PRs and main branch changes
  pull_request :
    types : [labeled]
jobs :
  code-review :
    if : ${{ contains( github.event.label.name, 'AutoReview') }}
    runs-on : ubuntu-latest
    permissions :
      contents : read
      pull-requests : write
    steps :
      - uses : actions/checkout@v3
      - uses : gvasilei/[email protected]
        env :
          NODE_OPTIONS : ' --experimental-fetch '
        with :
          github_token : ${{ secrets.GITHUB_TOKEN }}
          openai_api_key : ${{ secrets.OPENAI_API_KEY }}
          exclude_files : ' *.json, *.md, *.yml ' # optionally exclude files based on a wildcard expression. 

Eingabeparameter

Parameter	Erforderlich	Standard	Beschreibung
github_token	WAHR		Notwendig für die Kommunikation mit GitHub. Automatisch generiert durch die GHA
openai_api_key	WAHR		OpenAI-API-Schlüssel
Modellname	FALSCH	gpt-3.5-turbo	OpenAI ChatModel. Unterstützt derzeit gpt-4 und gpt-3.5-turbo
model_temperature	FALSCH	0	Temperatur des OpenAI-Modells
ausschließende_Dateien	FALSCH		Geben Sie einen Platzhalterausdruck an, um Dateien von der Codeüberprüfung auszuschließen. Beispielsweise schließt *.md alle Markdown-Dateien aus. Mehrere Ausdrücke werden über Kommas unterstützt, z. B. *.js, *.cjs

? Vorteile

Die Verwendung unserer GitHub-Aktion bietet viele Vorteile, wie zum Beispiel:

• Schnellere Codeüberprüfungen
• Konsistenteres Feedback
• Erhöhte Produktivität
• Verbesserte Codequalität

? Einschränkungen

• Diese GitHub-Aktion befindet sich noch in der frühen Entwicklung.
• Während die Aktion sowohl gpt-4 als auch gpt-3.5-turbo unterstützt, liefert gpt-4 viel bessere Vorschläge.

? Mitwirken

Wenn Sie Ideen oder Verbesserungen zu unserer GitHub-Aktion haben, können Sie gerne eine PR einreichen. Wir freuen uns über alle Beiträge!