Static Analysis と GitHub Actions

概要

GitHub Action ワークフローで Datadog Static Analysis ジョブを実行します。

Static Analysis は非公開ベータ版です。アクセスをリクエストするには、サポートにご連絡ください。

セットアップ

Datadog Static Analysis を使用するには、リポジトリのルートディレクトリに static-analysis.datadog.yml ファイルを追加して、使用するルールセットを指定する必要があります。

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

Python の例

Python ベースのリポジトリの例を見ることができます。

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

ワークフロー

Datadog Static Analysis ジョブを実行するためのファイルを .github/workflows に作成します。

以下はワークフローファイルのサンプルです。

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"

Datadog API キーとアプリケーションキーを GitHub リポジトリにシークレットとして設定する必要があります。詳しくは、API とアプリケーションキーを参照してください。

入力

Static Analysis に以下のパラメーターを設定することができます。

名前説明必須デフォルト
dd_api_keyDatadog API キー。このキーは Datadog 組織によって作成され、シークレットとして保存する必要があります。はい
dd_app_keyDatadog アプリケーションキー。このキーは Datadog 組織によって作成され、シークレットとして保存する必要があります。はい
dd_service結果のタグ付けを希望するサービス。はい
dd_env結果をタグ付けしたい環境。Datadog は、この入力値として ci を使用することを推奨します。✕none
dd_site情報を送信する Datadog サイト。✕datadoghq.com