Gradle@3 - Gradle v3 タスク

[アーティクル]
03/18/2023

Gradle ラッパースクリプトを使用してビルドするには、このタスクを使用します。

構文

# Gradle v3
# Build using a Gradle wrapper script.
- task: Gradle@3
  inputs:
    gradleWrapperFile: 'gradlew' # string. Alias: wrapperScript. Required. Gradle wrapper. Default: gradlew.
    #workingDirectory: # string. Alias: cwd. Working directory. 
    #options: # string. Options. 
    tasks: 'build' # string. Required. Tasks. Default: build.
  # JUnit Test Results
    #publishJUnitResults: true # boolean. Publish to Azure Pipelines. Default: true.
    testResultsFiles: '**/TEST-*.xml' # string. Required when publishJUnitResults = true. Test results files. Default: **/TEST-*.xml.
    #testRunTitle: # string. Optional. Use when publishJUnitResults = true. Test run title. 
  # Code Coverage
    #codeCoverageToolOption: 'None' # 'None' | 'Cobertura' | 'JaCoCo'. Alias: codeCoverageTool. Code coverage tool. Default: None.
    codeCoverageClassFilesDirectories: 'build/classes/main/' # string. Alias: classFilesDirectories. Required when codeCoverageTool != None. Class files directories. Default: build/classes/main/.
    #codeCoverageClassFilter: # string. Alias: classFilter. Optional. Use when codeCoverageTool != None. Class inclusion/exclusion filters. 
    #codeCoverageFailIfEmpty: false # boolean. Alias: failIfCoverageEmpty. Optional. Use when codeCoverageTool != None. Fail when code coverage results are missing. Default: false.
    #codeCoverageGradle5xOrHigher: true # boolean. Alias: gradle5xOrHigher. Optional. Use when codeCoverageTool = JaCoCo. Gradle version >= 5.x. Default: true.
  # Advanced
    javaHomeOption: 'JDKVersion' # 'JDKVersion' | 'Path'. Alias: javaHomeSelection. Required. Set JAVA_HOME by. Default: JDKVersion.
    #jdkVersionOption: 'default' # 'default' | '1.11' | '1.10' | '1.9' | '1.8' | '1.7' | '1.6'. Alias: jdkVersion. Optional. Use when javaHomeSelection = JDKVersion. JDK version. Default: default.
    #jdkDirectory: # string. Alias: jdkUserInputPath. Required when javaHomeSelection = Path. JDK path. 
    #jdkArchitectureOption: 'x64' # 'x86' | 'x64'. Alias: jdkArchitecture. Optional. Use when jdkVersion != default. JDK architecture. Default: x64.
    #gradleOptions: '-Xmx1024m' # string. Alias: gradleOpts. Set GRADLE_OPTS. Default: -Xmx1024m.
  # Code Analysis
    #sonarQubeRunAnalysis: false # boolean. Alias: sqAnalysisEnabled. Run SonarQube or SonarCloud Analysis. Default: false.
    #sqGradlePluginVersionChoice: 'specify' # 'specify' | 'build'. Required when sqAnalysisEnabled = true. SonarQube scanner for Gradle version. Default: specify.
    #sonarQubeGradlePluginVersion: '2.6.1' # string. Alias: sqGradlePluginVersion. Required when sqAnalysisEnabled = true && sqGradlePluginVersionChoice = specify. SonarQube scanner for Gradle plugin version. Default: 2.6.1.
    #checkStyleRunAnalysis: false # boolean. Alias: checkstyleAnalysisEnabled. Run Checkstyle. Default: false.
    #findBugsRunAnalysis: false # boolean. Alias: findbugsAnalysisEnabled. Run FindBugs. Default: false.
    #pmdRunAnalysis: false # boolean. Alias: pmdAnalysisEnabled. Run PMD. Default: false.
    #spotBugsAnalysis: false # boolean. Alias: spotBugsAnalysisEnabled. Run SpotBugs. Default: false.
    #spotBugsGradlePluginVersionChoice: 'specify' # 'specify' | 'build'. Required when spotBugsAnalysisEnabled = true. Spotbugs plugin version. Default: specify.
    #spotbugsGradlePluginVersion: '4.7.0' # string. Required when spotBugsAnalysisEnabled = true && spotBugsGradlePluginVersionChoice = specify. Version number. Default: 4.7.0.

入力

gradleWrapperFile - Gradle ラッパー
入力エイリアス: wrapperScript。 string. 必須です。既定値: gradlew。

ビルドに使用する gradlew リポジトリ内のラッパーの場所を指定します。 Windows 上のエージェント (Microsoft でホストされるエージェントを含む) では、ラッパーを使用する gradlew.bat 必要があります。 Linux または macOS 上のエージェントは、シェルスクリプトを gradlew 使用できます。 Gradle ラッパーの詳細については、こちらを参照してください。

workingDirectory - 作業ディレクトリ
入力エイリアス: cwd。 string.

Gradle ビルドを実行する作業ディレクトリを指定します。作業ディレクトリが指定されていない場合、タスクはリポジトリのルートディレクトリを使用します。

options - オプション
string.

Gradle ラッパーに渡されるコマンドラインオプションを指定します。詳細については、「 Gradle コマンドライン」を参照してください。

tasks - タスク
string. 必須です。既定値: build。

Gradle が実行するタスク。タスク名のリストはスペースで区切る必要があり、コマンドプロンプトから発行されたものから gradlew tasks 取得できます。

詳細については、「 Gradle ビルドスクリプトの基本」を参照してください。

publishJUnitResults - Azure Pipelines に発行する
boolean. 既定値: true。

Gradle ビルドによって生成された JUnit テスト結果を Azure Pipelines に発行します。このタスクでは、Azure Pipelines でのテスト実行として、各テスト結果ファイルの一致 Test Results Files が発行されます。

testResultsFiles - テスト結果ファイル
string. の場合 publishJUnitResults = trueは必須です。既定値: **/TEST-*.xml。

テスト結果のファイルパス。ワイルドカードを使用できます。たとえば、 **/TEST-*.xml 名前がで始まるすべての XML ファイルについて TEST-です。

testRunTitle - テスト実行のタイトル
string. 省略可能。の場合は publishJUnitResults = trueを使用します。

このビルドの JUnit テストケースの結果の名前を指定します。

codeCoverageToolOption - コードカバレッジツール
入力エイリアス: codeCoverageTool。 string. 許可値: None、Cobertura、JaCoCo。既定値: None。

ビルドのテストケースでカバーされるコードを決定するコードカバレッジツールを指定します。

codeCoverageClassFilesDirectories - クラスファイルディレクトリ
入力エイリアス: classFilesDirectories。 string. の場合 codeCoverageTool != Noneは必須です。既定値: build/classes/main/。

クラスファイルとアーカイブファイル (.jar、.war など) を含むディレクトリのコンマ区切りの一覧。これらのディレクトリ内のクラスファイルに対してコードカバレッジが報告されます。通常、タスクは Gradle ビルドの既定のクラス build/classes/java/main ディレクトリである ( Gradle 4 以降の場合) のクラスを検索します。

codeCoverageClassFilter - クラス包含/除外フィルター
入力エイリアス: classFilter。 string. 省略可能。の場合は codeCoverageTool != Noneを使用します。

コードカバレッジの収集からクラスを含めるか除外するフィルターのコンマ区切りのリスト。例: +:com.*,+:org.*,-:my.app*.*.

codeCoverageFailIfEmpty - コードカバレッジの結果が見つからない場合に失敗する
入力エイリアス: failIfCoverageEmpty。 boolean. 省略可能。の場合は codeCoverageTool != Noneを使用します。既定値: false。

コードカバレッジで発行する結果が生成されなかった場合、ビルドが失敗します。

codeCoverageGradle5xOrHigher - Gradle バージョン >= 5.x
入力エイリアス: gradle5xOrHigher。 boolean. 省略可能。の場合は codeCoverageTool = JaCoCoを使用します。既定値: true。

gradle バージョンが = 5.x の場合は、 >これを 'true' に設定します。

javaHomeOption - によってJAVA_HOMEを設定する
入力エイリアス: javaHomeSelection。 string. 必須です。使用できる値: JDKVersion (JDK バージョン)、 Path。既定値: JDKVersion。

ビルド中にタスクが検出する JDK バージョンを選択するか、JDK パスを手動で入力して、JAVA_HOMEを設定します。

jdkVersionOption - JDK バージョン
入力エイリアス: jdkVersion。 string. 省略可能。の場合は javaHomeSelection = JDKVersionを使用します。使用できる値は、 default1.11 、(JDK 11)、 1.10 (JDK 10 (サポート対象外)、 1.9 (JDK 9 (サポート対象外)、 1.8 (JDK 8) 1.7 、(JDK 7)、 1.6 (JDK 6 (サポート対象外)) です。既定値: default。

選択した JDK バージョンへのパスを検出し、それに応じてJAVA_HOMEを設定しようとします。

jdkDirectory - JDK パス
入力エイリアス: jdkUserInputPath。 string. の場合 javaHomeSelection = Pathは必須です。

JAVA_HOMEを指定したパスに設定します。

jdkArchitectureOption - JDK アーキテクチャ
入力エイリアス: jdkArchitecture。 string. 省略可能。の場合は jdkVersion != defaultを使用します。使用できる値: x86、x64。既定値: x64。

JDK アーキテクチャ (x86 または x64) を提供します。

gradleOptions - GRADLE_OPTSの設定
入力エイリアス: gradleOpts。 string. 既定値: -Xmx1024m。

GRADLE_OPTS環境変数を設定します。これは、コマンドライン引数を送信して JVM を開始するために使用されます。フラグは xmx 、JVM で使用可能な最大メモリを指定します。

sonarQubeRunAnalysis - SonarQube または SonarCloud 分析を実行する
入力エイリアス: sqAnalysisEnabled。 boolean. 既定値: false。

このオプションは 、Gradle タスクのバージョン 1 から SonarQube および SonarCloud マーケットプレース拡張機能を使用するように変更されました。 [タスク] フィールドでタスクを実行した後に SonarQube または SonarCloud 分析を実行するには、このオプションを有効にします。また、この Gradle タスクの前に、いずれかの拡張機能からビルドパイプラインに 分析構成の準備 タスクを追加する必要があります。

sqGradlePluginVersionChoice - Gradle バージョン用 SonarQube スキャナー
string. の場合は sqAnalysisEnabled = true必須です。使用できる値: specify (バージョン番号を指定します) build 、(build.gradle に適用されているプラグインを使用します)。既定値: specify。

使用する SonarQube Gradle プラグインのバージョンを指定します。 Gradle 構成ファイルでバージョンを宣言するか、この文字列でバージョンを指定します。

sonarQubeGradlePluginVersion - Gradle プラグインバージョン用の SonarQube スキャナー
入力エイリアス: sqGradlePluginVersion。 string. の場合は sqAnalysisEnabled = true && sqGradlePluginVersionChoice = specify必須です。既定値: 2.6.1。

SonarQube Gradle プラグインのバージョン番号を格納します。

checkStyleRunAnalysis - Checkstyle を実行する
入力エイリアス: checkstyleAnalysisEnabled。 boolean. 既定値: false。

既定の Sun チェックを使用して Checkstyle ツールを実行します。結果はビルド成果物としてアップロードされます。

findBugsRunAnalysis - FindBugs を実行する
入力エイリアス: findbugsAnalysisEnabled。 boolean. 既定値: false。

FindBugs 静的分析ツールを使用して、コード内のバグを検索します。結果はビルド成果物としてアップロードされます。 Gradle 6.0 では、このプラグインは削除されました。代わりに SpotBugs プラグインを使用してください。

pmdRunAnalysis - PMD を実行する
入力エイリアス: pmdAnalysisEnabled。 boolean. 既定値: false。

PMD Java 静的分析ツールを使用して、コード内のバグを探します。結果はビルド成果物としてアップロードされます。

spotBugsAnalysis - SpotBugs を実行する
入力エイリアス: spotBugsAnalysisEnabled。 boolean. 既定値: false。

を実行すると、が実行されますspotBugstrue。このプラグインは Gradle v5.6 以降で動作します。 SpotBugs Gradle プラグインの使用の詳細を確認してください。プラグインは予期しない方法で動作するか、以前の Gradle バージョンではまったく動作しない可能性があります。

spotBugsGradlePluginVersionChoice - Spotbugs プラグインのバージョン
string. の場合は spotBugsAnalysisEnabled = true必須です。使用できる値: specify (バージョン番号を指定します) build 、(build.gradle に適用されているプラグインを使用します)。既定値: specify。

使用する SpotBugs Gradle プラグインのバージョンを指定します。バージョンは Gradle 構成ファイルで宣言することも、この文字列でバージョンを指定することもできます。

spotbugsGradlePluginVersion - バージョン番号
string. の場合は spotBugsAnalysisEnabled = true && spotBugsGradlePluginVersionChoice = specify必須です。既定値: 4.7.0。

SpotBugs Gradle プラグインのバージョン番号が含まれています。

タスクコントロールのオプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。詳細については、「コントロールオプションと一般的なタスクプロパティ」を参照してください。

出力変数

[なし] :

解説

SonarQube 分析の構成は、タスク Prepare Analysis Configurationの SonarQube または SonarCloud 拡張機能に移動されました。

Gradle ラッパースクリプトを使用してビルドするには、このタスクを使用します。

Gradle プロジェクトからラッパーを生成操作方法?

Gradle ラッパーを使用すると、ビルドエージェントは、JVM 以外のビルドエージェント自体にソフトウェア構成を行うことなく、リポジトリにチェックインされた正確な Gradle 環境をダウンロードして構成できます。

build.gradle が存在するルートプロジェクトディレクトリから次のコマンドを発行して、Gradle ラッパーを作成します。

jamal@fabrikam> gradle wrapper
Gradle ラッパーをリモートリポジトリにアップロードします。

gradle ラッパー ( gradle/wrapper/gradle-wrapper.jarにあります) によって生成されるバイナリ成果物があります。このバイナリファイルは小さく、更新は必要ありません。ビルドエージェントで Gradle 構成の実行を変更する必要がある場合は、を更新します gradle-wrapper.properties。

リポジトリは次のようになります。

|-- gradle/
    `-- wrapper/
        `-- gradle-wrapper.jar
        `-- gradle-wrapper.properties
|-- src/
|-- .gitignore
|-- build.gradle
|-- gradlew
|-- gradlew.bat

依存関係操作方法ダウンロードするときのタイムアウトを修正しますか?

依存関係のダウンロード時などの Read timed out エラーを修正するために、Gradle 4.3 以降のユーザーはをに追加 -Dhttp.socketTimeout=60000 -Dhttp.connectionTimeout=60000 してタイムアウトを Options変更できます。これにより、タイムアウトが 10 秒から 1 分に増加します。

例

Gradle を使用して Java アプリをビルドする

必要条件

要件	説明
パイプラインの種類	YAML、クラシックビルド
実行日	エージェント、DeploymentGroup
確認要求	なし
Capabilities	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	Any
設定可能な変数	Any
エージェントのバージョン	1.91.0 以上
タスクのカテゴリ	Build

次の方法で共有

Gradle@3 - Gradle v3 タスク

構文

入力

タスクコントロールのオプション

出力変数

解説

Gradle プロジェクトからラッパーを生成操作方法?

依存関係操作方法ダウンロードするときのタイムアウトを修正しますか?

例

必要条件

フィードバック

その他のリソース

次の方法で共有

Gradle@3 - Gradle v3 タスク

構文

入力

タスク コントロール のオプション

出力変数

解説

Gradle プロジェクトからラッパーを生成操作方法?

依存関係操作方法ダウンロードするときのタイムアウトを修正しますか?

例

必要条件

フィードバック

その他のリソース

タスクコントロールのオプション