Datadog Static Analyzer Github Action

Overview

Run a Datadog Static Analysis job in your GitHub Action workflows.

Setup

To use Datadog Static Analysis, you need to add a static-analysis.datadog.yml file to your repository's root directory to specify which rulesets to use.

rulesets:
  - <ruleset-name>
  - <ruleset-name>

Example for Python

You can see an example for Python-based repositories:

rulesets:
  - python-code-style
  - python-best-practices
  - python-inclusive

Workflow

Create a file in .github/workflows to run a Datadog Static Analysis job.

The following is a sample workflow file.

on: [push]

jobs:
  check-quality:
    runs-on: ubuntu-latest
    name: Datadog Static Analyzer
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Check code meets quality standards
        id: datadog-static-analysis
        uses: DataDog/datadog-static-analyzer-github-action@v1
        with:
          dd_app_key: ${{ secrets.DD_APP_KEY }}
          dd_api_key: ${{ secrets.DD_API_KEY }}
          dd_service: "my-service"
          dd_env: "ci"
          dd_site: {{< region-param key="dd_site" code="true" >}}
          cpu_count: 2
          enable_performance_statistics: false

You must set your Datadog API and application keys as secrets in your GitHub repository whether at the organization or repository level. For more information, see API and Application Keys.

Inputs

You can set the following parameters for Static Analysis.

Name	Description	Required	Default
dd_api_key	Your Datadog API key. This key is created by your Datadog organization and should be stored as a secret.	Yes
dd_app_key	Your Datadog application key. This key is created by your Datadog organization and should be stored as a secret.	Yes
dd_service	The service you want your results tagged with.	Yes
dd_env	The environment you want your results tagged with. Datadog recommends using ci as the value for this input.	No	none
dd_site	The Datadog site to send information to.	No	datadoghq.com
cpu_count	Set the number of CPUs used to by the analyzer.	No	2
enable_performance_statistics	Get the execution time statistics for analyzed files.	No	false
debug	Lets the analyzer print additional logs useful for debugging. To enable, set to yes.	No	no
subdirectory	The subdirectory path the analysis should be limited to. The path is relative to the root directory of the repository.	No

Further Reading

Additional helpful documentation, links, and articles:

• Learn about Code Analysis