Análisis estático y CircleCI Orbs

CircleCI Build Status CircleCI Orb Version GitHub License CircleCI Community

Información general

Ejecuta una tarea de análisis estático de Datadog en tus flujos de trabajo de CircleCI.

Configuración

Para utilizar el análisis estático de Datadog, debes añadir un archivo static-analysis.datadog.yml en el directorio raíz de tu repositorio para especificar qué conjuntos de reglas utilizar.

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

Ejemplo para Python

Puedes ver un ejemplo para los repositorios basados en Python:

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

Flujo de trabajo

Crea un archivo en .circleci para ejecutar un trabajo de análisis estático de Datadog.

A continuación se muestra un ejemplo de archivo de flujo de trabajo.

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: 
          cpu_count: 2
          enable_performance_statistics: false
workflows:
  main:
    jobs:
      - run-static-analysis-job

Variables de entorno

Configura las siguientes variables de entorno en la página de configuración del proyecto de CircleCI.

NombreDescripciónObligatorio
DD_API_KEYTu clave de la API de Datadog. Esta clave la crea tu organización de Datadog y debe guardarse como secreto.
DD_APP_KEYTu clave de la aplicación de Datadog. Esta clave la crea tu organización de Datadog y debe guardarse como secreto.

Entradas

Para personalizar tu flujo de trabajo, puedes configurar los siguientes parámetros para el análisis estático.

NombreDescripciónObligatorioPredeterminado
serviceEl servicio con el que deseas que se etiqueten los resultados.
envEl entorno con el que deseas que se etiqueten los resultados. Datadog recomienda utilizar ci como valor para esta entrada.Nonone
siteEl sitio de Datadog al que enviar la información.Nodatadoghq.com
cpu_countConfigura el número de CPU utilizadas por el analizador.No2
enable_performance_statisticsObtén las estadísticas del tiempo de ejecución de los archivos analizados.Nofalse

Referencias adicionales

Más enlaces, artículos y documentación útiles:

PREVIEWING: guacbot/translation-pipeline