Voraussetzungen
Damit die hier beschriebenen Repositoryeigenschaften wirksam werden können, müssen Sie eingerichtet code scanninghaben. Siehe Informationen zu Konfigurationstypen für die Code-Analyse.
Repositoryeigenschaften, die sich auf die Auswirkungen auswirken code scanning , müssen manuell für Ihre Organisation erstellt werden. Sie können dann Werte für sie festlegen, die für Ihre gesamte Organisation gelten, oder sie für jedes Repository anders konfigurieren lassen. Siehe Verwalten von benutzerdefinierten Eigenschaften für Repositorys in Ihrer Organisation.
Testen von Änderungen vor der Anwendung
Sie können testen, dass konfigurationen, die über Repositoryeigenschaften angewendet werden, die gewünschten Auswirkungen haben, bevor Sie sie für Ihre gesamte Organisation bereitstellen. Repositoryeigenschaften können auf bestimmte Werte für einzelne Repositorys festgelegt werden. Wenn Sie eine Repositoryeigenschaft zum ersten Mal konfigurieren, erstellen Sie sie für Ihre Organisation, legen sie aber nicht auf einen Wert fest. Legen Sie ihn stattdessen auf einen Wert für ein bestimmtes Test-Repository fest, in dem Sie die Änderung zuerst überprüfen können. Nach der Überprüfung in einem Testrepository können Sie dann den Wert für Ihre gesamte Organisation oder die gewünschten Repositorys festlegen.
Wenn Sie den Wert einer unterstützten Repositoryeigenschaft ändern, können Sie denselben Ansatz verwenden. Setzen Sie den Wert der Repositoryeigenschaft für ein Testrepository außer Kraft, überprüfen Sie die Änderung, und stellen Sie sie dann für Ihre Organisation oder andere Repositorys bereit.
Unterstützte Repositoryeigenschaften für code scanning
Einige code scanning Funktionen können mithilfe von Repositoryeigenschaften konfiguriert werden. Organisationen können Repositoryeigenschaften verwenden, um Konfigurationen für alle Repositorys und für einzelne Repositorys zu erzwingen. Wenn code scanning sie mithilfe von Repositoryeigenschaften angepasst wird, gilt die Anpassung für alle Setuptypen.
Im Folgenden finden Sie eine Übersicht über Repositoryeigenschaften, die Sie bei der Konfiguration einrichten können, die sich auf Analysen auswirken code scanning :
| Name | Typ |
|---|---|
github-codeql-extra-queries | Text |
github-codeql-disable-overlay | True/false |
github-codeql-file-coverage-on-prs | True/false |
Hinweis
Die unterstützten Repositoryeigenschaften hängen von der Version der github/codeql-action ab, die von Ihren code scanning Analysen verwendet wird. Überprüfen code scanning Sie bei der erweiterten Einrichtung, ob Ihr Workflow auf die neueste Hauptversion verweist. Code scanning Standardsetup verwendet automatisch die neueste Version. Wenn der Server, auf dem Sie ausgeführt GitHub Enterprise Server werden, nicht mit dem Internet verbunden ist, müssen Sie möglicherweise das CodeQL Synchronisierungstool für Aktionen verwenden. Siehe Konfigurieren der Code-Analyse für Ihr Gerät.
Anpassung der Analyse
Mit der github-codeql-extra-queries Eigenschaft können Sie zusätzliche Abfragen konfigurieren, die ausgeführt werden sollen. Dies ist hilfreich, um Abfragen zu allen relevanten Analysen in Ihrer Organisation hinzuzufügen, ohne einzelne Workflows ändern oder zu einer erweiterten Einrichtung wechseln zu müssen. Dies akzeptiert dieselben Werte wie die queries Eingabe der github/codeql-action. Siehe Workflowkonfigurationsoptionen für die Codeüberprüfung.
Aktivieren oder Deaktivieren von Features
Sie können die verbesserte inkrementelle Analyse deaktivieren, indem Sie die github-codeql-disable-overlay Eigenschaft auf truefestlegen. Dies kann nützlich sein, wenn eine verbesserte inkrementelle Analyse aufgrund erhöhter Hardwareanforderungen fehlschlägt.
Dateiabdeckungsinformationen werden nicht für Analysen von Pullanforderungen berechnet. Wenn Sie Dateiabdeckungsinformationen für Pullanforderungen aktivieren möchten, können Sie die github-codeql-file-coverage-on-prs Eigenschaft auf truefestlegen.