Skip to main content

Festlegen des Zusammenführungsschutzes für Codeüberprüfung

Sie können Regelsätze verwenden, um code scanning-Zusammenführungsschutz für Pull Requests festzulegen.

Wer kann dieses Feature verwenden?

Code scanning ist für alle öffentlichen Repositorys auf GitHub.com verfügbar. Zur Verwendung von code scanning in einem privaten organisationseigenen Repository musst du über eine Lizenz für GitHub Advanced Security verfügen. Weitere Informationen findest du unter Informationen zu GitHub Advanced Security.

Informationen zur Verwendung von Regelsätzen für code scanning-Zusammenführungsschutz

Hinweise:

  • Dieses Feature befindet sich derzeit in der Betaversion und wird ggf. noch geändert.
  • Der Zusammenführungsschutz mit Regelsätzen bezieht sich nicht auf Statusprüfungen. Weitere Informationen zu Statusüberprüfungen finden Sie unter „Informationen zu Statuschecks.“

Sie können Regelsätze verwenden, um zu verhindern, dass Pull Requests zusammengeführt werden, wenn eine der folgenden Bedingungen erfüllt ist:

  • Ein erforderliches Tool hat eine code scanning-Warnung eines Schweregrads gefunden, der in einem Regelsatz definiert ist.

  • Eine erforderliche % data variables.product.prodname_code_scanning %}-Toolanalyse wird noch ausgeführt.

  • Für das Repository ist kein erforderliches code scanning-Tool konfiguriert.

Weitere Informationen zu code scanning-Warnungen finden Sie unter „Informationen zu Codeüberprüfungswarnungen.“

Sie können den Zusammenführungsschutz mit Regelsätzen im Repository oder Organisationsebenen festlegen und für Repositorys, die entweder mit dem Standardsetup oder dem erweiterten Setup konfiguriert sind. Sie können auch die REST-API verwenden, um den Zusammenführungsschutz mit Regelsätzen festzulegen.

Weitere Informationen zu Regelsätzen findest du unter Informationen zu Regelsätzen.

Erstellen eines Zusammenführungsschutz-Regelsatzes für ein Repository

  1. Navigiere auf GitHub.com zur Hauptseite des Repositorys.

  2. Wähle unter dem Namen deines Repositorys die Option Einstellungen aus. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  3. Klicke auf der linken Randleiste unter „Code und Automatisierung“ auf Regeln und dann auf Regelsätze.

    Screenshot: Randleiste der Seite „Einstellungen“ für ein Repository Das Untermenü „Regeln“ ist erweitert, und die Option „Regelsätze“ ist orange umrandet.

  4. Klicken Sie auf Neuer Regelsatz.

  5. Klicke auf Neuer Regelsatz für Branches, um einen Regelsatz für Branches zu erstellen.

  6. Geben Sie unter „Regelsatzname“ einen Namen für den Regelsatz ein.

  7. Um den standardmäßigen Durchsetzungsstatus zu ändern, klicken Sie auf Deaktiviert und wählen Sie einen Durchsetzungsstatus aus. Weitere Informationen zu Erzwingstatus finden Sie unter „Informationen zu Regelsätzen.“

  8. Wählen Sie unter „Verzweigungsschutz“ code scanning-Ergebnisse anfordern.

  9. Klicken Sie unter „Erforderliche Tools und Warnungsschwellenwerte“ auf Tool hinzufügen und wählen Sie ein code scanning-Tool mit der Dropdownliste aus. Zum Beispiel „CodeQL“.

  10. Neben dem Namen eines code scanning-Tools:

    • Klicken Sie auf Warnungen und wählen Sie eine der folgenden Optionen aus: Keine, Fehler, Fehler und Warnungen oder Alle.
    • Klicken Sie auf Sicherheitswarnungen und wählen Sie eine der folgenden Optionen aus: Keine, Kritisch, Hoch oder höher, Mittel oder höher oder Alle.

    Screenshot des Abschnitts „Erforderliche Tools und Warnungsschwellenwerte“ der Einstellungen „Regelsätze“.

Weitere Informationen zu Warnungsschweregraden und Sicherheitsschweregraden finden Sie unter „Informationen zu Codeüberprüfungswarnungen“.

Weitere Informationen zur Verwaltung der Regelsätze einer Repository finden Sie unter „Verwalten von Regelsätzen für ein Repository.“

Erstellen eines Zusammenführungsschutzregelnets für alle Repositorys in einer Organisation

  1. Wähle in der oberen rechten Ecke von GitHub.com dein Profilfoto aus. Klicke dann auf Deine Organisationen.

    Screenshot des Dropdownmenüs unter dem Profilbild von @octocat. „Deine Organisationen“ ist in dunklem Orange eingerahmt.

  2. Klicke neben der Organisation auf Einstellungen.

  3. Wähle auf der linken Randleiste im Abschnitt „Code, Planung und Automatisierung“ die Option Repository aus, und klicke dann auf Regelsätze.

    Screenshot: Seite „Einstellungen“ einer Organisation Auf der Randleiste ist ein Link mit der Bezeichnung „Regelsätze“ orange umrandet.

  4. Klicken Sie auf Neuer Regelsatz.

  5. Klicke auf Neuer Regelsatz für Branches, um einen Regelsatz für Branches zu erstellen.

  6. Geben Sie unter „Regelsatzname“ einen Namen für den Regelsatz ein.

  7. Um den standardmäßigen Durchsetzungsstatus zu ändern, klicken Sie auf Deaktiviert und wählen Sie einen Durchsetzungsstatus aus. Weitere Informationen zu Erzwingstatus finden Sie unter „Informationen zu Regelsätzen.“

  8. Wählen Sie unter „Verzweigungsschutz“ code scanning-Ergebnisse anfordern.

  9. Klicken Sie unter „Erforderliche Tools und Warnungsschwellenwerte“ auf Tool hinzufügen und wählen Sie ein code scanning-Tool mit der Dropdownliste aus. Zum Beispiel „CodeQL“.

  10. Neben dem Namen eines code scanning-Tools:

    • Klicken Sie auf Warnungen und wählen Sie eine der folgenden Optionen aus: Keine, Fehler, Fehler und Warnungen oder Alle.
    • Klicken Sie auf Sicherheitswarnungen und wählen Sie eine der folgenden Optionen aus: Keine, Kritisch, Hoch oder höher, Mittel oder höher oder Alle.

    Screenshot des Abschnitts „Erforderliche Tools und Warnungsschwellenwerte“ der Einstellungen „Regelsätze“.

Weitere Informationen zu Warnungsschweregraden und Sicherheitsschweregraden finden Sie unter „Informationen zu Codeüberprüfungswarnungen“.

Weitere Informationen zur Verwaltung der Regelsätze für Repositorys in einer Organisation finden Sie unter „Verwalten von Regelsätzen für Repositorys in deiner Organisation.“

Erstellen eines Regelsatzes für den Zusammenführungsschutz mit der REST-API

Sie können die REST-API verwenden, um einen Regelsatz mit der code_scanning-Regel zu erstellen, der es Ihnen ermöglicht, spezifische Tools zu definieren und Warnungsschwellenwerte festzulegen. Weitere Informationen findest du unter REST-API-Endpunkte für Regeln.