Maven

メイン設定

ゴール

TeamCity で実行させたい Maven ゴールをスペースで区切ってリストします。一部の Maven ゴールはバージョン管理システムを使用できるため、一部の VCS チェックアウトモードゴールと互換性がなくなる可能性があります。

このようなゴールを実行するには、バージョン管理設定ページの VCS チェックアウトモードドロップダウンメニューで「エージェントに自動的に」を選択してください。これにより、ゴール実行ソフトウェアでバージョン管理システムが利用できるようになります。Perforce P4 で release:prepare ゴールを使用する方法については、こちらのセクションを参照してください。

作業ディレクトリ

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

詳細設定

POM の場所

ビルド作業ディレクトリを基準とした POM ファイルへの相対パス。デフォルトでは pom.xml と同じです。

ランナーの議論

コマンドラインパラメーターのリスト。

Maven バージョン

使用する Maven のバージョンを選択します。インストールされているバージョンを管理することもできます。

• <自動> - Maven インストールへのパスは M2_HOME 環境変数から取得されます。それ以外の場合は、現在のデフォルトバージョンが使用されます。

• <Default> — バンドルバージョンがデフォルトとして使用されます。デフォルトの変更方法については、こちらを参照してください。

• <Custom> — カスタム Maven バージョンへのパスを指定します。

ビルド設定

これらの設定は、ビルド構成内で使用される Maven ステップでのみ使用できます。

ユーザー設定の選択

様々な種類のユーザー設定を選択できます。この設定は、-s または --settings コマンドライン引数を追加するのと同じです。使用可能なオプションは以下のとおりです。

• <Default> — エージェントのデフォルトの Maven の場所からユーザー設定をインポートします。参照: Maven サーバー側設定。

• <Custom> — 代替ユーザー設定ファイルへのパスを指定できます。パスはエージェントとサーバーの両方で有効である必要があります。

• 定義済み設定 — プロジェクト設定 | Maven 設定ページで、TeamCity サーバーにアップロードされた設定ファイルから 1 つを選択できます。アップロードされたファイルは、現在のプロジェクトとそのすべてのサブプロジェクトの両方で使用でき、<TeamCity Data Directory>/config/projects/%projectID%/pluginData/mavenSettings ディレクトリに保存されます。アップロードされたファイルは、エージェント側とサーバー側の Maven 機能の両方で使用されます。

カスタム設定または定義済み設定を使用する場合、有効なユーザー設定ファイルへのパスは、maven プロセス内で teamcity.maven.userSettings.path システムプロパティとして使用できます。

アーティファクトリポジトリ

次のいずれかのローカルアーティファクトリポジトリオプションを選択できます。

• エージェントごと (デフォルト) - エージェントによって実行されるすべてのビルドによって生成されたアーティファクトを、エージェントシステムディレクトリに別個のリポジトリを使用して保存します。

• ビルド構成ごと - 現在のビルド構成のすべてのビルドによって生成されたアーティファクトを保存するには、別のリポジトリを使用します。

• Maven デフォルト — デフォルトの Maven リポジトリの場所を使用します。リポジトリは、すべてのビルド構成とマシン上のすべてのエージェント間で共有されます。

  このモードでは、Maven ステップは追加のコマンドラインパラメーター -Dmaven.repo.local で指定された場所を使用します。このパラメーターが指定されていない場合は、settings.xml で設定された値を検索します。

インクリメンタルビルド

増分ビルドの一般的な考え方は、変更されたモジュールのみを処理し、それらと接続された変更されていないモジュールの再処理に時間を費やさないことです。TeamCity はこの方法を利用して、変更された Maven モジュールのみのテストを実行し、ビルドまたはビルドチェーンを再実行する際の時間を節約します。

Maven 自体はインクリメンタルビルドのサポートが非常に限られているため、TeamCity は独自の変更影響分析アルゴリズムを使用して影響を受けるモジュールのセットを決定し、影響を受けるモジュールの依存関係を作成するための特別な予備段階を使用します。

最初に TeamCity は、親関係とさまざまな依存関係スコープを考慮して、独自の変更影響分析を実行し、影響を受けるモジュールを判別します。次に、ビルドは 2 つの連続した Maven 実行に分割されます。

準備フェーズと呼ばれる最初の Maven の実行は、影響を受けるモジュールの依存関係を構築することを目的としています。準備段階では、依存関係クラスが存在しないか矛盾していることが原因で、2 回目の実行時にコンパイラーやその他のエラーが発生しないようにします。

メインフェーズと呼ばれる 2 回目の Maven の実行では、メインゴール（たとえば test）が実行されるため、変更の影響を受けるテストのみが実行されます。

また、このトピックに関連するブログ投稿(英語)を確認してください。

コンテナー設定

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

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

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

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

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

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

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

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

コードカバレッジ

Maven ビルドランナーは、IDEA カバレッジエンジンに基づくコードカバレッジをサポートします。コードカバレッジオプションの構成については、Java コードカバレッジの設定ページを参照してください。

同じマシンに複数のビルドエージェントがインストールされている場合、デフォルトではそれらは同じローカルリポジトリを使用します。ただし、各ローカルエージェントにカスタムローカルリポジトリを割り当てる方法は 2 つあります。

• teamcity-agent/conf/buildAgent.properties で次のプロパティを指定します。

  system.maven.repo.local=%\system.agent.work.dir%/<subdirectory_name>

  たとえば、%system.agent.work.dir%/m2-repository です。

• 各ビルドエージェントを異なるユーザーアカウントで実行します。

Maven リリースと Perforce の使用

Maven リリースプラグインには、Perforce で認証するためのチケットが必要(英語)です。

TeamCity のビルド構成の Perforce VCS ルート設定:

1. エージェントでチェックアウトを有効にします。

2. Perforce VCS ルート設定でチケットベースの認証を使用するを有効にします。

3. ビルドエージェント環境に、Maven Release Plugin の実行を妨げる可能性のある時折の P4 変数がないことを確認してください。

4. Maven ビルドステップのゴールフィールドに release:prepare を指定してビルドを実行します。

Git VCS で Maven リリースを使用する

このプラグインを Git で使用するには、pom.xml で Git SSHURL を SCM の URL(英語) として設定します。

TeamCity エージェントの場合:

1. エージェントに Git がインストールされ、Unix ライクな OS ではエージェントの $PATH に、Windows では %PATH% 環境変数に追加されていることを確認してください。

2. エージェントで、次を実行してアカウントの ID を設定します

   git config --system user.email "buildserver@example.com" git config --system user.name "TeamCity Server"

3. Git VCS がエージェントの既知のホストデータベースに追加されていることを確認してください。

TeamCity サーバーの場合:

1. SSH 鍵の Git を TeamCity サーバーにアップロードします。

2. 構成設定を開き、バージョン管理設定設定タブに移動します。

3. エージェントでチェックアウトを有効にします。

4. Git VCS ルートで、秘密鍵認証を有効にします。

5. SSH エージェントビルド機能を構成に追加します。

6. Maven ビルドステップのゴールフィールドに release:prepare を指定してビルドを実行します。