Wenn Ihre Protokolle nicht detailliert genug sind, um ein Problem zu beheben, gibt es mehrere Schritte, die Sie ausführen können, um zusätzliche Informationen zu erhalten und Protokolle nützlicher zu machen.
Debug-Schrittprotokollierung aktivieren
Bei der Debug-Schrittprotokollierung werden ausführlichere Protokolle während und nach der Ausführung erstellt.
So aktivieren Sie die Schritt-Debugprotokollierung:
- Legen Sie im Repository, das den Workflow enthält, den folgenden geheimen Schlüssel oder die variable fest: auf . Wenn sowohl das Geheimnis als auch die Variable gesetzt sind, hat der Wert des Geheimnisses Vorrang vor der Variable.
- Führen Sie den Workflow erneut aus, oder lösen Sie eine neue Ausführung aus.
Sobald Sie das Geheimnis oder die Variable festgelegt haben, werden weitere Debug-Ereignisse in den Schrittprotokollen aufgeführt. Weitere Informationen findest du unter AUTOTITLE.
Sie können den Kontext auch verwenden, um Schritte nur bedingt auszuführen, wenn die Debugprotokollierung aktiviert ist. Weitere Informationen findest du unter AUTOTITLE.
Erstellen von CodeQL-Debugartefakten
Warnung
CodeQL-Debugartefakte enthalten eine Kopie des Quellcodes, der von CodeQL analysiert wird. Daher wird empfohlen, diese Pakete nur für Personen freizugeben, die für den Zugriff auf diesen Quellcode autorisiert sind.
Du kannst Artefakte abrufen, um CodeQL zu debuggen. Die Debugartefakte werden in die Workflowausführung hochgeladen, als Artefakte mit Namen, die mit beginnen. Wenn CodeQL mehrere Sprachen gleichzeitig während einer Workflowausführung analysiert, gibt es für jede Sprache ein solches Artefakt. Die Daten umfassen die CodeQL Logs, CodeQL Datenbanken, extrahierte Quellcodedateien sowie sämtliche durch den Workflow erzeugten SARIF-Dateien. Weitere Informationen zum Herunterladen von CodeQL-Artefakten findest du unter AUTOTITLE.
Diese Artefakte helfen beim Debuggen von Problemen mit CodeQL code scanning. Wenn Sie GitHub-Support kontaktieren, werden sie möglicherweise nach diesen Daten gefragt.
Erstellen von CodeQL Debuggen von Artefakten für CodeQL-Standardeinrichtung
Sie können CodeQL Debugartefakte erstellen, indem Sie die Schritt-Debugprotokollierung aktivieren (siehe Aktivieren der Schritt-Debugprotokollierung) und eine neue CodeQL Analyse auslösen, z. B. durch das Hochladen eines neuen Commits an einen Pull-Request-Zweig.
Wenn Sie CodeQL Zugriff auf private Registrierungen erteilt haben, stehen zusätzliche Artefakte, deren Namen mit beginnen, zur Verfügung. Diese enthalten Protokolle des Authentifizierungsproxys, der vom Standardsetup von CodeQL zum Authentifizieren von Anfragen an private Registrierungen verwendet wird und zur Behebung von Problemen bei privaten Registrierungs-Konfigurationen genutzt werden kann. Weitere Informationen findest du unter AUTOTITLE.
Erstellen von CodeQL Debuggen von Artefakten für die erweiterte Einrichtung von CodeQL
Das Debuggen von Artefakten für die erweiterte Einrichtung von CodeQL kann auf mehrere verschiedene Arten erreicht werden.
Erneute Ausführung von Aufträgen mit aktivierter Debugprotokollierung
Die einfachste Option zum Erstellen von Debug-Artefakten für CodeQL erweitertes Setup ist die Ausführung der Jobs erneut mit aktiviertem Debug-Logging. Weitere Informationen zum erneuten Ausführen von GitHub Actions-Workflows und -Aufträgen findest du unter AUTOTITLE.
Du musst sicherstellen, dass du Debugprotokollierung aktivieren auswählst. Dadurch werden die Runnerdiagnoseprotokollierung und die schrittweise Debugprotokollierung für die Ausführung aktiviert. Anschließend können Sie die Debugging-Artefakte von CodeQL herunterladen, um weiter zu untersuchen. Du musst die Workflowdatei nicht ändern, wenn du CodeQL-Debugartefakte durch erneutes Ausführen von Aufträgen erstellst.
Verwenden eines Workflow-Kennzeichens
Du kannst CodeQL-Debugartefakte mithilfe eines Flags in deinem Workflow erstellen. Ändere dazu den -Schritt deiner CodeQL-Analyseworkflow-Datei, und lege fest.
- name: Initialize CodeQL
uses: github/codeql-action/init@v4
with:
debug: true
Verwendung der Schritt-Debugprotokollierung von GitHub Actions
Wenn Sie die Schritt-Debugprotokollierung für GitHub Actions aktivieren, erzeugt CodeQL auch Debug-Artefakte und lädt sie als Teil der Workflow-Ausführung hoch. Anweisungen finden Sie unter Aktivieren der Schritt-Debugprotokollierung.