Festlegen von Schwellenwerten für die Codequalität für Pullanforderungen

Erstellen Sie ein Code Quality Gate für Pull-Anforderungen, um die Qualität des Codes zu verbessern, der in Ihr Repository integriert wird.

Wer kann dieses Feature verwenden?

Repositorybesitzer, Organisationsbesitzer und Benutzer mit der Administratorrolle

GitHub Team oder GitHub Enterprise Cloud

In diesem Artikel

Einleitung

Sie können Pull-Anforderungen blockieren, die Ihre Codequalitätsstandards nicht erfüllen, indem Sie die Branchregel "Ergebnisse der Codequalität erforderlich" zu einem Regelsatz hinzufügen und den erforderlichen Schweregrad angeben. Wenn eine Pullanforderung diesen Schwellenwert nicht erreicht, kann sie nicht zusammengeführt werden.

Voraussetzungen

Hinweis

Der Schwellenwert wirkt sich nur aus, wenn das Repository Code in einer oder mehreren der unterstützten Sprachen aufweist, siehe Aktivieren von GitHub Code Quality.

Bestätigen, dass Code Quality erfolgreich für Pull-Requests ausgeführt wird.

Bevor Sie einen Regelsatz hinzufügen oder aktualisieren, um einen Schwellenwert für Code Quality einzuschließen, vergewissern Sie sich, dass der Codequalität Workflow läuft und Ergebnisse zurück an die Pull Requests übermittelt. Andernfalls könnte das Regelset das Zusammenführen aller Pullanforderungen blockieren.

  1. Öffnen Sie eine aktuelle Pull Request und scrollen Sie zur Zusammenfassung der "Prüfungen" ganz unten in der Pull Request.
  2. Vergewissern Sie sich, dass die Überprüfung "CodeQL – Codequalität" erfolgreich ausgeführt wurde und ihr Status erfasst wurde.

Weitere Informationen finden Sie unter CodeQL-basierte Analyse für Codequalität.

Hinzufügen oder Aktualisieren eines Regelsatzes, um Code Quality einzuschließen

  1. Navigieren Sie zur Registerkarte "Einstellungen" Ihres Repositorys.
  2. Erweitern Sie auf der linken Seitenleiste unter „Code und Automatisierung“ -Regeln, und klicken Sie dann auf Regelsätze.
  3. Wenn Sie noch nicht über ein Regelset zum Schutz Ihrer Standardverzweigung verfügen, erweitern Sie Neues Regelset, und klicken Sie auf "Neue Verzweigungsregelset". Öffnen Sie alternativ Ihren vorhandenen Regelsatz für den Standardzweig und gehen Sie zu Schritt 5 über.
  4. Wenn Sie ein neues Regelset erstellen:
    • Definieren Sie einen Namen für den Regelsatz.
    • Legen Sie den "Erzwingungsstatus" auf "Aktiv" fest.
    • Fügen Sie unter "Zielverzweigungen" ein Ziel von "Standardverzweigung einschließen" hinzu.
  5. Aktivieren Sie unter „Verzweigungsregeln“ das Kontrollkästchen „Ergebnisse zur Codequalität anfordern“.
  6. Legen Sie "Schweregrad" fest, um den niedrigsten Schweregrad von Codequalitätsergebnissen zu definieren, die aufgelöst werden müssen, bevor eine Pullanforderung in die Standardverzweigung zusammengeführt werden kann. Beispiel:
    • Setzen Sie "Fehler", um Pull-Requests mit ungelösten Codequalitätsfehlern von der Zusammenführung auszuschließen.
    • Setzen Sie "Warnungen und höher", um Pull-Anfragen, die nicht aufgelöste Code-Qualitätswarnungen oder Fehler enthalten, am Zusammenführen zu hindern.
    • Legen Sie „Notizen und höher“ fest, um die Zusammenführung von Pullanforderungen mit nicht aufgelösten Notizen zur Codequalität, Warnungen oder Fehlern zu blockieren.
    • Legen Sie "Alle" fest, um Pullanforderungen mit allen nicht aufgelösten Codequalitätsergebnissen zu blockieren, die zusammengeführt werden.
  7. Wenn Sie die Definition oder Bearbeitung des Regelsets abgeschlossen haben, klicken Sie auf "Änderungen erstellen " oder "Speichern".

Nächste Schritte

Erfahren Sie, wie GitHub Code Quality für Pullanforderungen funktioniert, um zu verhindern, dass Codequalitätsprobleme in die Standardverzweigung gelangen. Weitere Informationen findest du unter Beheben von Codequalität-Feststellungen, bevor Sie Ihren Pull Request zusammenführen.