Static Code Analysis and CircleCI Orbs Run a Datadog Static Code Analysis job in your CircleCI workflows.
To use Datadog Static Code Analysis, you need to add a static-analysis.datadog.yml file in your repository’s root directory to specify which rulesets to use.
rulesets :
- <ruleset-name>
- <ruleset-name>
Copy
You can see an example for Python-based repositories:
rulesets :
- python-code-style
- python-best-practices
- python-inclusive
Copy
Create a file in .circleci to run a Datadog Static Code Analysis job.
The following is a sample workflow file.
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 : datadoghq.com
cpu_count : 2
enable_performance_statistics : false
workflows :
main :
jobs :
- run-static-analysis-job
Copy
Set the following environment variables in the CircleCI Project Settings page .
Name Description Required DD_API_KEYYour Datadog API key. This key is created by your Datadog organization and should be stored as a secret. Yes DD_APP_KEYYour Datadog application key. This key is created by your Datadog organization and should be stored as a secret. Yes
To customize your workflow, you can set the following parameters for Static Code Analysis.
Name Description Required Default serviceThe service you want your results tagged with. Yes envThe environment you want your results tagged with. Datadog recommends using ci as the value for this input. No nonesiteThe Datadog site to send information to. No datadoghq.comcpu_countSet the number of CPUs used to by the analyzer. No 2enable_performance_statisticsGet the execution time statistics for analyzed files. No false
