Static Analysis と CircleCI Orbs
概要
CircleCI ワークフローで 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 ジョブを実行するためのファイルを .circleci に作成します。
以下はワークフローファイルのサンプルです。
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
workflows:
main:
jobs:
- run-static-analysis-job
環境変数
CircleCI Project Settings ページで以下の環境変数を設定してください。
| 名前 | 説明 | 必須 |
|---|
DD_API_KEY | Datadog API キー。このキーは Datadog 組織によって作成され、シークレットとして保存する必要があります。 | はい |
DD_APP_KEY | Datadog アプリケーションキー。このキーは Datadog 組織によって作成され、シークレットとして保存する必要があります。 | はい |
入力
ワークフローをカスタマイズするために、Static Analysis に以下のパラメーターを設定することができます。
| 名前 | 説明 | 必須 | デフォルト |
|---|
service | 結果をタグ付けしたいサービス。 | はい | |
env | 結果をタグ付けしたい環境。Datadog は、この入力値として ci を使用することを推奨します。 | ✕ | none |
site | 情報を送信する Datadog サイト。 | ✕ | datadoghq.com |
