Set code scanning merge protection

Secure your codebase by blocking pull requests that fail code scanning checks.

Wer kann dieses Feature verwenden?

Organisationsbesitzerinnen, Sicherheitsmanagerinnen und Organisationsmitglieder mit der Administratorrolle

Code scanning ist für die folgenden Repositorytypen verfügbar:

  • Öffentliche Repositorys auf GitHub.com
  • Organisationseigene Repositorys für GitHub Team, GitHub Enterprise Cloud oder GitHub Enterprise Server, wobei GitHub Code Security aktiviert sind.

In diesem Artikel

Creating a merge protection ruleset for a repository

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Klicke unter dem Repositorynamen auf Settings. 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. Click New ruleset.

  5. To create a ruleset targeting branches, click New branch ruleset.

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

  7. Um den Standarderzwingungsstatus zu ändern, kannst du optional auf Disabled klicken und einen Erzwingungsstatus auswählen.

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

  9. Klicke unter „Required tools and alert thresholds“ auf Add tool, und wähle 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 findest du unter Informationen zu Codeüberprüfungswarnungen.

For more information about managing rulesets in a repository, see Verwalten von Regelsätzen für ein Repository.

Creating a merge protection ruleset for all repositories in an organization

  1. Klicke in der rechten oberen Ecke von GitHub auf dein Profilbild und dann auf Your organizations.

  2. Klicke neben der Organisation auf Einstellungen.

  3. Klicke auf der linken Randleiste im Abschnitt „Code, planning, and automation“ auf Repository und anschließend auf Rulesets.

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

  4. Click New ruleset.

  5. To create a ruleset targeting branches, click New branch ruleset.

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

  7. Um den Standarderzwingungsstatus zu ändern, kannst du optional auf Disabled klicken und einen Erzwingungsstatus auswählen.

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

  9. Klicke unter „Required tools and alert thresholds“ auf Add tool, und wähle 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 findest du unter Informationen zu Codeüberprüfungswarnungen.

For more information about managing rulesets for repositories in an organization, see Verwalten von Regelsätzen für Repositorys in deiner Organisation.

Creating a merge protection ruleset with the REST API

You can use the REST API to create a ruleset with the code_scanning rule, which allows you to define specific tools and set alert thresholds. For more information, see REST-API-Endpunkte für Regeln.