Sie können für ein einzelnes Repository oder für jedes Repository in einer Organisation gleichzeitig aktivieren Code Quality . Die Aktivierung auf Organisationsebene gibt all Ihren Teams mit nur einer einzigen Änderung eine einheitliche Qualitätsbasis, während Sie mit der Aktivierung pro Repository gezielt bestimmte Projekte auswählen oder die Einführung schrittweise vornehmen können.
Voraussetzungen
- Ein Unternehmensbesitzer muss Code Quality in Ihrem Unternehmen zugelassen haben. Weitere Informationen findest du unter Verwendung von GitHub Code Quality in Ihrem Unternehmen zulassen.
- GitHub Actions muss aktiviert sein, da Code Quality Aktionen verwendet, um jede CodeQL-Analyse auszuführen.
- Um den vollen Nutzen des Features zu erhalten, sollte Ihr Repository eine der Sprachen enthalten, die für die Qualitätsanalyse unterstützt werden.CodeQL Siehe unterstützte Sprachen.
Aktivieren von Code Quality für Ihr Repository
-
Navigieren Sie auf GitHub zur Hauptseite des Repositorys.
-
Klicke unter dem Repositorynamen auf Settings. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.
-
Klicken Sie Codequalität in der Randleiste unter "Sicherheit", um die Seite "Codequalität" anzuzeigen.
-
Klicken Sie auf "Codequalität aktivieren".
-
Überprüfen Sie die Informationen auf der Codequalitätsseite:
- Sprachen: Wenn Sie die Analyse für eine der Sprachen deaktivieren möchten, deaktivieren CodeQL Sie das zugehörige Kontrollkästchen.
- Runner-Typ: Wenn Sie einen anderen Läufer verwenden möchten, wählen Sie "Gekennzeichneter Läufer " aus, und definieren Sie die Bezeichnung "Runner". Weitere Informationen findest du unter Verwenden von auf GitHub gehosteten Runnern und Verwenden von Bezeichnungen mit selbstgehosteten Runnern.
-
Klicken Sie auf " Änderungen speichern ", um Ihre Konfiguration zu Code Qualityspeichern.
Wenn Ihre Organisation die Zwischenspeicherung privater Registrierungen konfiguriert hat, stehen diese zur Codequalitätsanalyse zur Verfügung, um Abhängigkeiten aufzulösen. Weitere Informationen findest du unter Gewähren des Zugriffs auf private Registrierungen für Sicherheitsfeatures.
Aktivieren Sie Code Quality für Ihre Organisation
Auf Organisationsebene steuern Sie Code Quality mit einer einzigen Einstellung Repositoryzugriff. Dadurch erhalten Sie granulare Optionen – von der Aktivierung aller Repositorys über die gezielte Auswahl einer bestimmten Liste bis hin zu einem dynamischen Filter –, sodass Sie Code Quality gezielt testen und in Ihrem eigenen Tempo einführen können. Repositorys innerhalb Ihrer Auswahl sind aktiviert, und Repositorys außerhalb Ihrer Auswahl sind deaktiviert.
Informationen zu den verfügbaren Zugriffsoptionen und zur Funktionsweise von Filtern und Erzwingen finden Sie unter Codequalitätsaktivierung in Organisationen und Unternehmen.
-
Navigieren Sie auf GitHub zur Hauptseite der Organisation.
-
Klicke unter dem Organisationsnamen auf Settings. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.
-
Klicken Sie in der Randleiste unter "Sicherheit" auf Codequalität.
-
Wählen Sie unter "Repositoryzugriff" eine Option aus dem Dropdownmenü aus.
- Wenn Sie ausgewählte Repositorys ausgewählt haben..., wählen Sie die Repositorys aus, die Sie aktivieren möchten.
- Wenn Sie Filter wird abgeglichen... ausgewählt haben, definieren Sie Ihren Filter.
-
Um optional zu verhindern, dass Repository-Administratoren diese Einstellungen ändern, aktivieren Sie die Option Zugriff erzwingen.
-
Wenn Ihre Änderung Code Quality für Repositorys aktiviert oder deaktiviert, wird ein Dialogfeld „Aktivierungs- und Abrechnungsänderungen überprüfen“ angezeigt, in dem die Gesamtzahl der aktivierten und deaktivierten Repositorys sowie die damit verbundenen Kosten angezeigt werden. Überprüfen Sie die Details, und klicken Sie dann auf "Bestätigen".
Ihre Änderungen werden automatisch gespeichert und beginnen sofort mit der Weitergabe. In großen Organisationen kann es mehrere Minuten dauern, bis die Änderungen für alle Repositorys gelten.
Wenn Sie das Feature für viele Teams bereitstellen, empfehlen wir Ihnen, eine Pilotphase für eine kleine Gruppe durchzuführen und Ihre Qualitätsschwellenwerte zu optimieren, bevor Sie überall aktivieren. Weitere Informationen findest du unter Rollout von GitHub Code Quality in großem Maßstab.
Nächste Schritte
- Codeabdeckung hinzufügen: Laden Sie die gemeldete Codeabdeckung aus Ihrer Testsuite hoch, um die Abdeckungsergebnisse direkt bei Pullanforderungen anzuzeigen. Weitere Informationen findest du unter Einrichten der Codeabdeckung für Ihr Repository.
- Für Ihre Organisation: Verstehen Sie den Codestatus Ihrer Repositorys auf einen Blick. Weitere Informationen findest du unter Untersuchung der GitHub-Codequalitätsergebnisse in Ihrer Organisation.