AI-Code-Reviewer herunterladen - AI-Code-Reviewer Quellcode herunterladen

ai codereviewer

Anderer Quellcode

view

Herunterladen

AI-Code-Reviewer

AI Code Reviewer ist eine GitHub-Aktion, die die GPT-4-API von OpenAI nutzt, um intelligentes Feedback und Vorschläge zu Ihren Pull-Anfragen bereitzustellen. Dieses leistungsstarke Tool trägt zur Verbesserung der Codequalität bei und spart Entwicklern Zeit, indem es den Codeüberprüfungsprozess automatisiert.

Merkmale

Überprüft Pull-Anfragen mithilfe der GPT-4-API von OpenAI.
Bietet intelligente Kommentare und Vorschläge zur Verbesserung Ihres Codes.
Filtert Dateien heraus, die den angegebenen Ausschlussmustern entsprechen.
Einfache Einrichtung und Integration in Ihren GitHub-Workflow.

Aufstellen

Um diese GitHub-Aktion verwenden zu können, benötigen Sie einen OpenAI-API-Schlüssel. Wenn Sie noch keinen haben, melden Sie sich bei OpenAI für einen API-Schlüssel an.
Fügen Sie den OpenAI-API-Schlüssel als GitHub Secret in Ihrem Repository mit dem Namen OPENAI_API_KEY hinzu. Weitere Informationen zu GitHub Secrets finden Sie hier.
Erstellen Sie eine .github/workflows/main.yml Datei in Ihrem Repository und fügen Sie den folgenden Inhalt hinzu:

 name : AI Code Reviewer

on :
  pull_request :
    types :
      - opened
      - synchronize
permissions : write-all
jobs :
  review :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout Repo
        uses : actions/checkout@v3

      - name : AI Code Reviewer
        uses : your-username/ai-code-reviewer@main
        with :
          GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret)
          OPENAI_API_KEY : ${{ secrets.OPENAI_API_KEY }}
          OPENAI_API_MODEL : " gpt-4 " # Optional: defaults to "gpt-4"
          exclude : " **/*.json, **/*.md " # Optional: exclude patterns separated by commas

Ersetzen Sie your-username durch Ihren GitHub-Benutzernamen oder den Namen Ihrer Organisation, in der sich das AI Code Reviewer-Repository befindet.
Passen Sie die exclude an, wenn Sie bestimmte Dateimuster von der Überprüfung ignorieren möchten.
Übernehmen Sie die Änderungen in Ihr Repository und AI Code Reviewer beginnt mit der Arbeit an Ihren zukünftigen Pull-Anfragen.

Wie es funktioniert

Die GitHub-Aktion AI Code Reviewer ruft den Pull-Request-Diff ab, filtert ausgeschlossene Dateien heraus und sendet Codeblöcke an die OpenAI-API. Anschließend generiert es Bewertungskommentare basierend auf der Antwort der KI und fügt sie dem Pull-Request hinzu.