GitHub

Verwenden Sie OpenSploit in GitHub-Problemen und Pull-Requests.

OpenSploit lässt sich in Ihren GitHub-Workflow integrieren. Erwähnen Sie /opensploit oder /oc in Ihrem Kommentar, und OpenSploit führt Aufgaben in Ihrem GitHub Actions-Runner aus.

Funktionen

Issue Triage: Bitten Sie OpenSploit, ein Problem zu untersuchen und es Ihnen zu erklären.
Reparieren und implementieren: Bitten Sie OpenSploit, ein Problem zu beheben oder eine Funktion zu implementieren. Und es funktioniert in einem neuen Branch und sendet ein PR mit allen Änderungen.
Sicher: OpenSploit läuft in den Runners Ihres GitHub.

Installation

Führen Sie den folgenden Befehl in einem Projekt aus, das sich in einem GitHub-Repository befindet:

opensploit github install

Dies führt Sie durch die Installation der GitHub-App, das Erstellen des Workflows und das Einrichten von Secrets.

Manuelle Einrichtung

Oder Sie können es manuell einrichten.

Installieren Sie die GitHub-App

Gehen Sie zu github.com/apps/opensploit-agent. Stellen Sie sicher, dass es im Ziel-Repository installiert ist.

Den Workflow hinzufügen

Fügen Sie die folgende Workflowdatei zu .github/workflows/opensploit.yml in Ihrem Repository hinzu. Stellen Sie sicher, dass Sie in env die passenden Werte für model und api_key setzen.

name: opensploit

on:
  issue_comment:
    types: [created]
  pull_request_review_comment:
    types: [created]

jobs:
  opensploit:
    if: |
      contains(github.event.comment.body, '/oc') ||
      contains(github.event.comment.body, '/opensploit')
    runs-on: ubuntu-latest
    permissions:
      id-token: write
    steps:
       - name: Checkout repository
         uses: actions/checkout@v6
         with:
           fetch-depth: 1
           persist-credentials: false

       - name: Run OpenSploit
        uses: silicon-works/opensploit/github@latest
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        with:
          model: anthropic/claude-sonnet-4-20250514
          # share: true
          # github_token: xxxx

Speichern Sie die API-Schlüssel in Secrets

Erweitern Sie in den Einstellungen Ihrer Organisation oder Ihres Projekts links Secrets und Variablen und wählen Sie Aktionen aus. Und fügen Sie die erforderlichen API-Schlüssel hinzu.

Konfiguration

model: Das mit OpenSploit zu verwendende Modell. Nimmt das Format provider/model an. Dies ist erforderlich.
agent: Der zu verwendende Agent. Muss ein Hauptagent sein. Fällt aus der Konfiguration auf default_agent oder "build" zurück, wenn es nicht gefunden wird.
share: Ob die OpenSploit-Sitzung geteilt werden soll. Der Standardwert ist true für öffentliche Repositorys.
prompt: Optionale benutzerdefinierte Eingabeaufforderung zum Überschreiben des Standardverhaltens. Verwenden Sie dies, um anzupassen, wie OpenSploit Anfragen verarbeitet.
token: Optionales GitHub-Zugriffstoken zum Ausführen von Vorgängen wie dem Erstellen von Kommentaren, dem Festschreiben von Änderungen und dem Öffnen von Pull Requests. Standardmäßig verwendet OpenSploit das Installation Access Token der OpenSploit GitHub-App, sodass Commits, Kommentare und Pull Requests so aussehen, als würden sie von der App kommen.

Alternativ können Sie built-in GITHUB_TOKEN des GitHub Action Runners verwenden, ohne die OpenSploit GitHub App zu installieren. Stellen Sie einfach sicher, dass Sie in Ihrem Workflow die erforderlichen Berechtigungen erteilen:
```
permissions:
  id-token: write
  contents: write
  pull-requests: write
  issues: write
```
Sie können bei Bedarf auch einen personal access tokens(PAT) verwenden.

Unterstützte Events

OpenSploit kann durch die folgenden GitHub-Events ausgelöst werden:

Ereignistyp	Ausgelöst durch	Einzelheiten
`issue_comment`	Kommentieren Sie ein Problem oder PR	Erwähnen Sie `/opensploit` oder `/oc` in Ihrem Kommentar. OpenSploit liest den Kontext und kann Branches erstellen, PRs öffnen oder antworten.
`pull_request_review_comment`	Kommentieren Sie bestimmte Codezeilen in einem PR	Erwähnen Sie `/opensploit` oder `/oc` beim Überprüfen des Codes. OpenSploit empfängt Dateipfad, Zeilennummern und Diff Context.
`issues`	Problem geöffnet oder bearbeitet	Lösen Sie OpenSploit automatisch aus, wenn Probleme erstellt oder geändert werden. Erfordert `prompt`-Eingabe.
`pull_request`	PR geöffnet oder aktualisiert	Lösen Sie OpenSploit automatisch aus, wenn PRs geöffnet, synchronisiert oder erneut geöffnet werden. Nützlich für automatisierte Bewertungen.
`schedule`	Cron-basierter Zeitplan	Führen Sie OpenSploit nach einem Zeitplan aus. Erfordert `prompt`-Eingabe. Die Ausgabe geht an Protokolle und PRs (kein Kommentar zu diesem Problem).
`workflow_dispatch`	Manueller Trigger von GitHub UI	Lösen Sie OpenSploit bei Bedarf über die Actions Tab aus. Erfordert `prompt`-Eingabe. Die Ausgabe erfolgt an Protokolle und PRs.

Beispiel für einen Zeitplan

Führen Sie OpenSploit nach einem Zeitplan aus, um automatisierte Aufgaben auszuführen:

name: Scheduled OpenSploit Task

on:
  schedule:
    - cron: "0 9 * * 1" # Every Monday at 9am UTC

jobs:
  opensploit:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: write
      pull-requests: write
      issues: write
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6
        with:
          persist-credentials: false

      - name: Run OpenSploit
        uses: silicon-works/opensploit/github@latest
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        with:
          model: anthropic/claude-sonnet-4-20250514
          prompt: |
            Review the codebase for any TODO comments and create a summary.
            If you find issues worth addressing, open an issue to track them.

Für geplante Ereignisse ist die Eingabe prompt erforderlich, da es keinen Kommentar gibt, aus dem Anweisungen extrahiert werden können. Geplante Workflows werden ohne Benutzerkontext zur Berechtigungsprüfung ausgeführt. Daher muss der Workflow contents: write und pull-requests: write gewähren, wenn Sie erwarten, dass OpenSploit Branches oder PRs erstellt.

Pull-Request-Beispiel

Überprüfen Sie PRs automatisch, wenn sie geöffnet oder aktualisiert werden:

name: opensploit-review

on:
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review]

jobs:
  review:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
      pull-requests: read
      issues: read
    steps:
      - uses: actions/checkout@v6
        with:
          persist-credentials: false
      - uses: silicon-works/opensploit/github@latest
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          model: anthropic/claude-sonnet-4-20250514
          use_github_token: true
          prompt: |
            Review this pull request:
            - Check for code quality issues
            - Look for potential bugs
            - Suggest improvements

Wenn für pull_request-Ereignisse kein prompt bereitgestellt wird, überprüft OpenSploit standardmäßig die Pull-Anfrage.

Beispiel für eine Issue-Triage

Neue Probleme automatisch selektieren. In diesem Beispiel wird nach Konten gefiltert, die älter als 30 Tage sind, um Spam zu reduzieren:

name: Issue Triage

on:
  issues:
    types: [opened]

jobs:
  triage:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: write
      pull-requests: write
      issues: write
    steps:
      - name: Check account age
        id: check
        uses: actions/github-script@v7
        with:
          script: |
            const user = await github.rest.users.getByUsername({
              username: context.payload.issue.user.login
            });
            const created = new Date(user.data.created_at);
            const days = (Date.now() - created) / (1000 * 60 * 60 * 24);
            return days >= 30;
          result-encoding: string

      - uses: actions/checkout@v6
        if: steps.check.outputs.result == 'true'
        with:
          persist-credentials: false

      - uses: silicon-works/opensploit/github@latest
        if: steps.check.outputs.result == 'true'
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        with:
          model: anthropic/claude-sonnet-4-20250514
          prompt: |
            Review this issue. If there's a clear fix or relevant docs:
            - Provide documentation links
            - Add error handling guidance for code examples
            Otherwise, do not comment.

Für issues-Ereignisse ist die Eingabe prompt erforderlich, da es keinen Kommentar gibt, aus dem Anweisungen extrahiert werden können.

Benutzerdefinierte Prompts

Überschreiben Sie die Standardaufforderung, um das Verhalten von OpenSploit für Ihren Workflow anzupassen.

- uses: silicon-works/opensploit/github@latest
  with:
    model: anthropic/claude-sonnet-4-5
    prompt: |
      Review this pull request:
      - Check for code quality issues
      - Look for potential bugs
      - Suggest improvements

Dies ist nützlich, um bestimmte Prüfkriterien, Kodierungsstandards oder Schwerpunktbereiche durchzusetzen, die für Ihr Projekt relevant sind.

Beispiele

Hier sind einige Beispiele, wie Sie OpenSploit in GitHub verwenden können.

Erklären Sie ein Problem

Fügen Sie diesen Kommentar in einer GitHub-Ausgabe hinzu.
```
/opensploit explain this issue
```
OpenSploit liest den gesamten Thread, einschließlich aller Kommentare, und antwortet mit einer klaren Erklärung.
Ein Problem beheben

Sagen Sie in einer GitHub-Ausgabe:
```
/opensploit fix this
```
Und OpenSploit erstellt einen neuen Branch, implementiert die Änderungen und öffnet ein PR mit den Änderungen.
PRs überprüfen und Änderungen vornehmen

Hinterlassen Sie den folgenden Kommentar auf einem GitHub PR.
```
Delete the attachment from S3 when the note is removed /oc
```
OpenSploit implementiert die angeforderte Änderung und schreibt sie an denselben PR fest.
Überprüfen Sie bestimmte Codezeilen

Hinterlassen Sie einen Kommentar direkt zu den Codezeilen auf der Files Tab von PR. OpenSploit erkennt automatisch die Datei, Zeilennummern und den Diff Context, um präzise Antworten bereitzustellen.
```
[Comment on specific lines in Files tab]
/oc add error handling here
```
Beim Kommentieren bestimmter Zeilen erhält OpenSploit:
- Die genaue Datei, die überprüft wird
- Die spezifischen Codezeilen
- Der umgebende Diff Context
- Informationen zur Zeilennummer
Dies ermöglicht gezieltere Anfragen, ohne dass Dateipfade oder Zeilennummern manuell angegeben werden müssen.