Gradle

メイン設定

タスク

このステップで実行する Gradle タスクのリスト（スペース区切り）。例: :myproject:clean :myproject:build または clean build このフィールドが空白の場合、default タスクが使用されます。TeamCity は現在、Gradle を使用した Java プロジェクトのビルドをサポートしています。Groovy、Scala、その他のプロジェクトのビルドはテストされていません。

このフィールドには追加のタスクオプション(英語)も入力する必要があります。例: :myproject:run --args="foo --bar" または clean test --tests MyTestClass.myTestMethod

作業ディレクトリ

ビルドステップが開始されるディレクトリです。デフォルトでは、エージェントがリモートソースをチェックアウトするルートディレクトリと同じです。詳細については、作業ディレクトリを構築するトピックを参照してください。

Gradle ラッパーを使用する

有効にすると、TeamCity はチェックアウトディレクトリ内の Gradle ラッパースクリプトを検索し、対応するステップ設定で指定された Gradle タスクと追加のコマンドラインパラメーターを使用して適切なスクリプトを起動します。この場合、Gradle ホームパスで指定された Gradle とエージェントにインストールされている Gradle は無視されます。

追加設定

Gradle ホーム

Gradle ホームディレクトリ（bin ディレクトリの親ディレクトリ）へのパス。指定されていない場合、TeamCity はエージェントの GRADLE_HOME 環境変数で指定された Gradle を使用します。エージェントに Gradle がインストールされていない場合は、代わりに Gradle ラッパーを使用できます。

ファイルのビルド

作業ディレクトリを基準にした Gradle ビルドファイル(英語)へのパス。空（デフォルト）の場合、Gradle は独自の設定を使用して決定します。

追加の Gradle コマンドラインパラメーター

オプションのスペース区切りの Gradle プロパティ(英語)のリスト。例: -x test (または --exclude-task test)、--configuration-cache、または -PmyProjectProperty=foo

Gradle ラッパーパス

作業ディレクトリを基準とした Gradle ラッパースクリプトへのオプションのパス。

インクリメンタルビルド

TeamCity は、Gradle :buildDependents 機能(英語)を利用できます。インクリメンタルビルドオプションが有効になっている場合、TeamCity はビルドの変更によって影響を受ける Gradle モジュールを検出し、それらのモジュールに対してのみ :buildDependents コマンドを開始します。これにより、Gradle は変更によって影響を受けるモジュールのみを完全にビルドしてテストします。

実行パラメーター

デバッグ

-d Gradle コマンドラインパラメーターを追加します。

スタックトレース

-s Gradle コマンドラインパラメーターを追加します。

コンテナー設定

このビルドステップは、Docker または Podman によってデプロイされたコンテナー内で実行できます。

クラシックビルド構成ステップでは、イメージ名、プラットフォーム、追加の実行引数を指定できる一連のプロパティが表示されます。明示的にイメージをプルするにより、このステップが実行されるたびに、TeamCity がターゲットコンテナーからイメージをプルすることが保証されます。

TeamCity が指定のイメージを検索するレジストリを指定するには、プロジェクトに Docker/Podman 接続を追加します。デフォルトでは、この接続により TeamCity は Docker Hub(英語) から匿名モードでイメージをプルできますが、任意のコンテナーレジストリに設定できます。

詳細については、次の記事を参照してください: コンテナーラッパー。

コンテナー内でステップを実行するには、Docker で実行をオンに切り替えます。有効にすると、この要素に 2 つのオプションが表示されます。

• Docker イメージ — Docker または Podman レジストリからイメージをプルできます。デフォルトでは、TeamCity は Docker、Hub イメージを匿名モードでプルできます。その他のケース（プライベートイメージ、カスタムイメージレジストリ、Docker、Hub のレート制限に違反しない非匿名モードなど）の場合は、パイプラインまたはジョブレベルで Docker 統合を設定してください。

• Dockerfile — Dockerfile からカスタムイメージを構築できます。

コードカバレッジ

Gradle ビルドランナーは、IDEA コードカバレッジエンジンおよび JaCoCo に基づくコードカバレッジをサポートします。

Java パラメーター

JDK

JDK を選択してください。このセクションは利用可能なオプションを詳しく述べています。デフォルトは JAVA_HOME 環境変数またはエージェント自身の Java です。

JDK ホームパス

このオプションは、上で <カスタム> を選択した場合に使用できます。このフィールドを使用して、ビルドの実行に使用するカスタム JDK へのパスを指定します。このフィールドを空白のままにすると、JDK ホームへのパスは、エージェントマシンの JAVA_HOME 環境変数から、またはビルドエージェント構成ファイル (buildAgent.properties) で指定された env.JAVA_HOME プロパティから読み取られます。これらの値が指定されていない場合、TeamCity はビルドエージェントプロセス自体の Java ホームを使用します。

JVM コマンドラインパラメーター

追加の JVM コマンドラインパラメーターを使用すると、初期および最大ヒープサイズの設定、追加のログの有効化、必要なバイトコード検証モードの選択などを行うことができます。

標準 ( - で始まる、たとえば -verbose:[class|module|gc|jni] または --dry-run) と非標準 ( -X で始まる、たとえば -Xmx<size> または -XstartOnFirstThread) の両方の JVM オプションを指定できます。

複数のコマンドラインパラメーターを指定するには、区切り文字としてスペースを使用します。例:

-verbose:gc -Xdiag -Xcomp -Xmx512m -Xms256m

現在の制限と既知の問題

次の場合には、Gradle 構成キャッシュが期待どおりに動作しない可能性があります。

• 仮想ビルド ( 並列テストまたはマトリックスビルド実行中に生成されたもの) が、キャッシュが作成されたときとは異なる順序で実行される場合。詳細については、この YouTrack チケットを参照してください: TW-86556(英語)。

• クリーンチェックアウトが有効な場合 ;

• ビルドステップが Docker または Podman コンテナー内で実行される場合。

• Gradle が構成キャッシュの問題を無視する(英語)場合。

• 追加のコマンドライン引数のリストに、Gradle ツール API (--daemon、--stop など) でサポートされていない引数が含まれている場合。

ビルドごとに値が常に変化するビルドパラメーター (たとえば、build.id または build.number) は、要求時にのみロードされます。直接参照 (たとえば、project.teamcity["build.number"]) を使用してこれらのプロパティの値を取得することはできますが、findProperty() メソッド (project.findProperty("build.number")) では結果は生成されません。Gradle スクリプトでこのメソッドを呼び出す必要がある場合は、次の回避策を使用します。

1. 新しい構成パラメーターを作成し、影響を受けるパラメーター MyBuildNumber=%build.number% にマップします。

2. 新しいシステムプロパティを作成し、それを新しい構成パラメーター system.buildNumber = %MyBuildNumber% にマップします。

3. ${findProperty}("buildNumber")} 構文を使用して、Gradle スクリプトで必要な値を取得します。

この回避策により、ビルド構成で構成キャッシュが再利用されなくなるため、無効にすることもできます。