Checks Code Compliance のスタートガイド

コード コンプライアンスは Checks CLI を介して使用され、結果は Checks Console にアップロードされます。

コード コンプライアンスをインストールする

まず、Checks CLI のインストール手順に沿って操作します。

インストールが完了すると、コード コンプライアンス コマンドを実行できるようになります。

checks code <command>

プロジェクトをスキャンする

Checks Code Compliance をインストールすると、コードベースをスキャンして、機密データの収集、共有、処理方法を把握できます。

Code Compliance CLI を使用してリポジトリ コードをスキャンするには、checks code scan コマンドを使用します。

たとえば、フォルダ repositories/personal にある my-swift-app リポジトリをテストするには:

checks code scan repositories/personal/my-swift-app

デフォルトでは、コード準拠は結果をターミナルのテキスト形式で出力します。

テスト結果を JSON 形式で出力する

結果をターミナルで JSON 形式でエクスポートするには:

checks code scan PATH --format=json > ./checks-code-results

結果を JSON 形式でエクスポートしてローカル ファイルに保存するには:

checks code scan PATH --format=json > ./checks-code-results.json

テスト結果を HTML 形式で出力する

結果をターミナルで HTML 形式でエクスポートするには:

checks code scan PATH --format=html > ./checks-code-results

結果を HTML 形式でエクスポートしてローカル ファイルに保存するには:

checks code scan PATH --format=html > ./checks-code-results.html

その他の参考情報

checks code scan --help を実行します。

自動スキャンを設定する

自動化されたコード コンプライアンス スキャンを設定するには、CI/CD の概要のドキュメントをご覧ください。

サポートの利用

Checks Code Compliance や Checks 全般についてサポートが必要な場合は、checks-support@google.com にメールでお問い合わせください。