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-config-file | Text |
github-codeql-extra-queries | Text |
github-codeql-disable-overlay | True/false |
github-codeql-file-coverage-on-prs | True/false |
github-codeql-tools | Text |
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.
Benutzerdefinierte Konfigurationsdateien
Sie können die github-codeql-config-file Eigenschaft auf den lokalen oder Remotepfad einer Konfigurationsdatei festlegen. Akzeptierte Werte für diese Eigenschaft sind identisch mit dem config-file Parameter der codeql-action/init Aktion. Weitere Informationen zu akzeptierten Pfadformaten und möglichen Inhalten von Konfigurationsdateien finden Sie unter Workflowkonfigurationsoptionen für die Codeüberprüfung.
Ein für die Eigenschaft angegebener Wert gilt sowohl für das github-codeql-config-file Standardsetup als code scanning auch code scanning für das erweiterte Setup. Wenn ein erweiterter Setup-Workflow eine explizite Eingabe für den config-file Parameter der codeql-action/init Aktion angibt, hat diese Eingabe Vorrang vor dem wert, der in der Repositoryeigenschaft konfiguriert ist. Auf diese Weise können erweiterte Workflows bei Bedarf unterschiedliche Konfigurationen als auf Standardsetupworkflows angewendete verwenden.
Eine mit der github-codeql-config-file Eigenschaft angewendete benutzerdefinierte Konfigurationsdatei wird mit der Konfiguration zusammengeführt, die code scanning vom Standardsetup automatisch generiert wird.
Code scanning Mit dem Standardsetup können Sie einige Analyseeinstellungen auf der Benutzeroberfläche anpassen, z. B. welche Bedrohungsmodelle oder CodeQL Modellpakete verwendet werden sollen. Diese Auswahl wird in der zusammengeführten Konfiguration beibehalten: Die in der Standardeinrichtungs-Benutzeroberfläche ausgewählten Bedrohungsmodelle werden mit allen bedrohungsmodellen kombiniert, die in der Konfigurationsdatei angegeben sind, und Modellpakete, die in der Benutzeroberfläche konfiguriert sind.Weitere Informationen zu den verfügbaren Konfigurationsoptionen im Standardsetup finden Sie unter code scanningInformationen zu Konfigurationstypen für die Code-Analyse.
Andere Analyseanpassungen
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.
Standardmäßig code scanning verwenden Analysen die neueste veröffentlichte Version von CodeQL. Es wird im Allgemeinen nicht empfohlen, dies zu ändern, es sei denn, Sie treten ein bestimmtes Problem auf, das behoben wird, indem Sie zu einer anderen Version wechseln. Wenn Sie dies ändern müssen, können Sie mit der github-codeql-tools Eigenschaft eine andere Version angeben.
Wenn ein erweiterter Setup-Workflow eine explizite Eingabe für den tools Parameter der codeql-action/init Aktion angibt, hat diese Eingabe Vorrang vor dem wert, der in der Repositoryeigenschaft konfiguriert ist. Auf diese Weise können erweiterte Workflows bei Bedarf unterschiedliche Konfigurationen als auf Standardsetupworkflows angewendete verwenden. Um den Wert der Repositoryeigenschaft auf erweiterte Setupworkflows zu erzwingen, auch wenn sie über eine explizite tools Eingabe verfügen, fügen Sie dem Wert der Repositoryeigenschaft ein ! Präfix hinzu. Erzwingt beispielsweise, !nightly dass alle Workflows die neueste nightly Version verwenden.
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.