Qodana 2024.1 ヘルプ

CircleCI

CircleCI は、クラウドベースの CI/CD システムです。次の手順に従って、CircleCI Qodana Orb(英語) を使用して Qodana を CircleCI パイプライン(英語)に構築できます。

  1. .circleci/config.yml ファイルを作成し、CircleCI バージョンを指定します。

version: 2.1
  1. CircleCI バージョンに orbs スタンザ(英語)を追加し、qodana 要素と Qodana バージョンを指定します。

orbs: qodana: jetbrains/qodana@2024.1

必要に応じて、必要なすべてのワークフローとジョブに対してこの手順を繰り返します。

  1. CircleCI UI で、未認定の Orbs(英語) の使用をオプトインします。

サンプル

この構成サンプルを使用すると、デフォルトの構成パラメーターを使用して Qodana でプロジェクトをスキャンできます。

version: '2.1' orbs: qodana: jetbrains/qodana@2024.1 jobs: code-quality: machine: image: 'ubuntu-2004:current' steps: - checkout - qodana/scan workflows: main: jobs: - code-quality: context: qodana

この構成サンプルは、args パラメーターを呼び出して、jetbrains/qodana-jvm のような特定のリンターを実行します。

version: 2.1 orbs: qodana: jetbrains/qodana@2024.1 jobs: code-quality: machine: image: 'ubuntu-2004:current' steps: - checkout - qodana/scan: args: -l jetbrains/qodana-jvm # use space to separate arguments workflows: main: jobs: - code-quality: context: qodana

Qodana クラウド

インスペクションの結果を Qodana クラウドに転送するには、QODANA_TOKEN プロジェクト変数(英語)を作成し、プロジェクトトークンをその値として保存するだけです。

トークンが分析用に設定されると、すべての Qodana ジョブの結果が Qodana クラウドプロジェクトにアップロードされます。

Qodana Cloud

コマンドとパラメーター

CircleCI Qodana Orb は、プロジェクトをインスペクションして結果をレポートできる scan コマンドを提供します。

この表には、scan コマンドでさらに使用できるオプションの文字列パラメーターのリストが含まれています。

パラメーター

説明

デフォルト値

primary-cache-key

生成されたキャッシュハッシュをカスタマイズする

qodana-2024.1-<< pipeline.git.branch >>-<< pipeline.git.revision >>

additional-cache-key

生成されたキャッシュハッシュをカスタマイズする

qodana-2024.1-<< pipeline.git.branch >>

args

Qodana CLI(英語) scan コマンドの追加引数

デフォルト値がありません

artifact-name

Qodana を使用したスキャンプロジェクトから生成されたアーティファクトの名前。スキャン結果のアップロードに使用されます

qodana-report

cache-dir

Qodana キャッシュのディレクトリ

/tmp/cache/qodana

results-dir

スキャン結果を保存するディレクトリ

/tmp/qodana/results