Static Analysis et Orbs CircleCI
Présentation
Exécutez une tâche Datadog Static Analysis dans vos workflows CircleCI.
Configuration
Pour utiliser la solution Static Analysis de Datadog, vous devez ajouter un fichier static-analysis.datadog.yml dans le répertoire racine de votre référentiel afin de spécifier les ensembles de règles à utiliser.
rulesets:
- <nom-ensemble-règles>
- <nom-ensemble-règles>
Exemple pour Python
Voici un exemple pour les référentiels basés sur Python :
rulesets:
- python-code-style
- python-best-practices
- python-inclusive
Workflow
Créez un fichier dans .circleci pour exécuter une tâche Static Analysis Datadog.
Vous trouverez ci-dessous un exemple de fichier de workflow.
version: 2.1
orbs:
datadog-static-analysis: datadog/datadog-static-analyzer-circleci-orb@1
jobs:
run-static-analysis-job:
docker:
- image: cimg/node:current
steps:
- checkout
- datadog-static-analysis/analyze:
service: "my-service"
env: "ci"
site:
Variables d’environnement
Définissez les variables d’environnement suivantes sur la page des paramètres de projet CircleCI.
| Nom | Rôle | Obligatoire |
|---|
DD_API_KEY | Votre clé d’API Datadog. Cette clé est créée par votre organisation Datadog. Elle doit être stockée sous la forme d’un secret. | Oui |
DD_APP_KEY | Votre clé d’application Datadog. Cette clé est créée par votre organisation Datadog. Elle doit être stockée sous la forme d’un secret. | Oui |
Paramètres
Pour personnaliser votre workflow, vous pouvez définir les paramètres suivants pour Static Analysis.
| Nom | Rôle | Obligatoire | Valeur par défaut |
|---|
service | Le service à appliquer comme tag à vos résultats. | Oui | |
env | L’environnement à appliquer comme tag à vos résultats. Datadog vous recommande d’utiliser ci comme valeur pour cette entrée. | Non | none |
site | Le site Datadog auquel envoyer les informations. | Non | datadoghq.com |
cpu_count | Définir le nombre de CPU utilisés par l’analyseur. | Non | 2 |
enable_performance_statistics | Récupérer les statistiques de temps d’exécution pour les fichiers analysés. | Non | false |
Pour aller plus loin
Documentation, liens et articles supplémentaires utiles :
