Prerequisites
Pour que les propriétés du référentiel décrites ici aient un effet, vous devez avoir configuré code scanning. Consultez « À propos des types d’installation pour l’analyse du code ».
Les propriétés du référentiel qui affectent code scanning doivent être créées manuellement pour votre organisation. Vous pouvez ensuite définir des valeurs pour celles-ci qui s’appliquent à l’ensemble de votre organisation ou les autoriser à être configurées différemment pour chaque référentiel. Consultez « Gestion des propriétés personnalisées pour les référentiels de votre organisation ».
Test des modifications avant de les appliquer
Vous pouvez tester que les configurations appliquées via les propriétés du référentiel ont les effets souhaités avant de les déployer dans toute votre organisation. Les propriétés du référentiel peuvent être définies sur des valeurs spécifiques pour des référentiels individuels. Si vous configurez une propriété de référentiel pour la première fois, créez-la pour votre organisation, mais ne la définissez pas sur une valeur. Au lieu de cela, définissez-le sur une valeur pour un référentiel de test spécifique où vous pouvez valider la modification en premier. Une fois validé sur un référentiel de test, vous pouvez ensuite définir la valeur de l’ensemble de votre organisation ou des référentiels souhaités.
Lorsque vous modifiez la valeur d’une propriété de référentiel prise en charge, vous pouvez utiliser la même approche. Remplacez ou définissez la valeur de la propriété de référentiel pour un référentiel de test, validez la modification, puis déployez-la dans votre organisation ou dans d’autres référentiels.
Propriétés de référentiel prises en charge pour code scanning
Certaines code scanning fonctionnalités peuvent être configurées à l’aide des propriétés du référentiel. Les organisations peuvent utiliser des propriétés de référentiel pour appliquer des configurations dans tous les référentiels et pour les dépôts individuels. Si code scanning elle est personnalisée à l’aide des propriétés du référentiel, la personnalisation s’applique à tous les types d’installation.
Voici une vue d’ensemble des propriétés du référentiel que vous pouvez configurer, ce qui affecte les code scanning analyses lorsqu’elles sont configurées :
| Nom | Type |
|---|---|
github-codeql-config-file | Texte |
github-codeql-extra-queries | Texte |
github-codeql-disable-overlay | Vrai/Faux |
github-codeql-file-coverage-on-prs | Vrai/Faux |
github-codeql-tools | Texte |
Remarque
Les propriétés du référentiel prises en charge dépendent de la version de l’action github/codeql utilisée par vos code scanning analyses. Pour code scanning une configuration avancée, vérifiez que votre flux de travail fait référence à la dernière version principale. Code scanning la configuration par défaut utilise automatiquement la dernière version.
Fichiers de configuration personnalisés
Vous pouvez définir la github-codeql-config-file propriété sur le chemin local ou distant d’un fichier de configuration. Les valeurs acceptées pour cette propriété sont identiques au config-file paramètre de l’action codeql-action/init . Pour plus d’informations sur les formats de chemin d’accès acceptés et le contenu possible des fichiers de configuration, consultez Options de configuration de flux de travail pour l’analyse du code.
Une valeur spécifiée pour la propriété s’applique à la fois code scanning à la github-codeql-config-file configuration par défaut et code scanning à l’installation avancée. Si un flux de travail d’installation avancé spécifie une entrée explicite pour le config-file paramètre de l’action codeql-action/init , cette entrée est prioritaire sur la valeur configurée dans la propriété du référentiel. Cela permet aux flux de travail avancés d’utiliser des configurations différentes de celles appliquées aux flux de travail d’installation par défaut, si vous le souhaitez.
Un fichier de configuration personnalisé appliqué à l’aide de la github-codeql-config-file propriété est fusionné avec la configuration générée code scanning automatiquement par défaut.
Code scanning La configuration par défaut vous permet de personnaliser certains paramètres d’analyse dans l’interface utilisateur, tels que les modèles de menace ou CodeQL les packs de modèles à utiliser. Ces sélections sont conservées dans la configuration fusionnée : les modèles de menace sélectionnés dans l’interface utilisateur d’installation par défaut sont combinés à tous les modèles de menace spécifiés dans le fichier de configuration, et les packs de modèles configurés dans l’interface utilisateur sont conservés.Pour plus d’informations sur les options de configuration disponibles dans la code scanning configuration par défaut, consultez À propos des types d’installation pour l’analyse du code.
Autres personnalisations d’analyse
La github-codeql-extra-queries propriété vous permet de configurer des requêtes supplémentaires qui doivent être exécutées. Cela est utile pour ajouter des requêtes à toutes les analyses pertinentes de votre organisation sans avoir à modifier des flux de travail individuels ou à basculer vers une configuration avancée. Cela accepte les mêmes valeurs que l’entrée queries du github/codeql-action. Consultez « Options de configuration de flux de travail pour l’analyse du code ».
Par défaut, code scanning les analyses utilisent la dernière version publiée de CodeQL. Il n’est généralement pas recommandé de modifier ce problème, sauf si vous rencontrez un problème spécifique résolu en basculant vers une autre version. Si vous avez besoin de le modifier, la github-codeql-tools propriété vous permet de spécifier une autre version.
Si un flux de travail d’installation avancé spécifie une entrée explicite pour le tools paramètre de l’action codeql-action/init , cette entrée est prioritaire sur la valeur configurée dans la propriété du référentiel. Cela permet aux flux de travail avancés d’utiliser des configurations différentes de celles appliquées aux flux de travail d’installation par défaut, si vous le souhaitez. Pour appliquer la valeur de la propriété de référentiel aux flux de travail d’installation avancés, même s’ils ont une entrée explicite tools , ajoutez un ! préfixe à la valeur de la propriété du référentiel. Par exemple, !nightly applique que tous les flux de travail utilisent la dernière nightly version.
Activation ou désactivation des fonctionnalités
Vous pouvez désactiver une analyse incrémentielle améliorée en définissant la github-codeql-disable-overlay propriété sur true. Cela peut être utile si l’analyse incrémentielle améliorée échoue en raison d’une configuration matérielle accrue.
Les couvertures de fichiers ne sont pas calculées pour les analyses des pull requests. Si vous souhaitez activer les informations de couverture de fichier pour les requêtes d'extraction, vous pouvez définir la propriété github-codeql-file-coverage-on-prs à true.