Gradle@2 - Gradle v2-taak

Bouwen met behulp van een Gradle wrapper-script.

Deze versie van de taak is afgeschaft; Gradle@3gebruiken.

Syntaxis

# Gradle v2
# Build using a Gradle wrapper script.
- task: Gradle@2
  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.17' | '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.

Invoer

gradleWrapperFile - Gradle-wrapper
Invoeralias: wrapperScript. string. Verplicht. Standaardwaarde: gradlew.

Hiermee geeft u de locatie van de gradlew wrapper in de opslagplaats die wordt gebruikt voor de build. Agents in Windows (inclusief door Microsoft gehoste agents) moeten gebruikmaken van de gradlew.bat wrapper. Agents in Linux of macOS kunnen het gradlew shell-script gebruiken. Meer informatie over de Gradle Wrapper. Als de Gradle-wrapper zich niet in de hoofdmap bevindt, geeft u het pad op naar het wrapper-script. Bijvoorbeeld: subdir/gradlew.

workingDirectory - werkmap
Invoeralias: cwd. string.

Hiermee geeft u de werkmap voor het uitvoeren van de Gradle-build. De taak maakt gebruik van de hoofdmap van de opslagplaats als de werkmap niet is opgegeven.

options - opties
string.

Hiermee geeft u de opdrachtregelopties die worden doorgegeven aan de Gradle-wrapper. Zie Gradle-opdrachtregel voor meer informatie.

tasks - taken
string. Verplicht. Standaardwaarde: build.

De taak(en) voor Gradle die moet worden uitgevoerd. Een lijst met taaknamen moet worden gescheiden door spaties en kan worden opgehaald uit gradlew tasks uitgegeven vanaf een opdrachtprompt.

Zie Gradle Build Script Basics voor meer informatie.

publishJUnitResults - publiceren naar Azure Pipelines
boolean. Standaardwaarde: true.

Publiceert JUnit-testresultaten die zijn geproduceerd door de Gradle-build naar Azure Pipelines. De taak publiceert elk testresultatenbestand dat overeenkomt met Test Results Files als een testuitvoering in Azure Pipelines.

testResultsFiles - testresultatenbestanden
string. Vereist wanneer publishJUnitResults = true. Standaardwaarde: **/TEST-*.xml.

Het bestandspad voor testresultaten. jokertekens kunnen worden gebruikt. Bijvoorbeeld **/TEST-*.xml voor alle XML-bestanden waarvan de naam begint met TEST-.

titel van testRunTitle - testuitvoering
string. Facultatief. Gebruiken wanneer publishJUnitResults = true.

Geeft een naam op voor de JUnit-testcaseresultaten voor deze build.

hulpprogramma voor codeCoverageToolOption - codedekking
Invoeralias: codeCoverageTool. string. Toegestane waarden: None, Cobertura, JaCoCo. Standaardwaarde: None.

Hiermee geeft u een hulpprogramma voor codedekking op om de code te bepalen die wordt gedekt door de testcases voor de build.

codeCoverageClassFilesDirectories - mappen met klasbestanden
Invoeralias: classFilesDirectories. string. Vereist wanneer codeCoverageTool != None. Standaardwaarde: build/classes/main/.

De door komma's gescheiden lijst met mappen met klassebestanden en archiefbestanden (.jar, .war en meer). Codedekking wordt gerapporteerd voor klassebestanden in deze mappen. Normaal gesproken zoekt de taak klassen onder build/classes/java/main (voor Gradle 4+), de standaardklassemap voor Gradle-builds.

codeCoverageClassFilter - filters voor insluiting/uitsluiting van klassen
Invoeralias: classFilter. string. Facultatief. Gebruiken wanneer codeCoverageTool != None.

De door komma's gescheiden lijst met filters om klassen op te nemen of uit te sluiten van het verzamelen van codedekking. Bijvoorbeeld: +:com.*,+:org.*,-:my.app*.*.

codeCoverageFailIfEmpty - mislukt wanneer de resultaten van de codedekking ontbreken
Invoeralias: failIfCoverageEmpty. boolean. Facultatief. Gebruiken wanneer codeCoverageTool != None. Standaardwaarde: false.

Mislukt de build als de codedekking geen resultaten heeft geproduceerd om te publiceren.

codeCoverageGradle5xOrHigher - Gradle-versie >= 5.x
Invoeralias: gradle5xOrHigher. boolean. Facultatief. Gebruiken wanneer codeCoverageTool = JaCoCo. Standaardwaarde: true.

Stel dit in op 'true' als gradle-versie is >= 5.x.

javaHomeOption - JAVA_HOME instellen door
Invoeralias: javaHomeSelection. string. Verplicht. Toegestane waarden: JDKVersion (JDK-versie), Path. Standaardwaarde: JDKVersion.

Hiermee stelt u JAVA_HOME in door een JDK-versie te selecteren die door de taak wordt gedetecteerd tijdens builds of door handmatig een JDK-pad in te voeren.

jdkVersionOption - JDK-versie
Invoeralias: jdkVersion. string. Facultatief. Gebruiken wanneer javaHomeSelection = JDKVersion. Toegestane waarden: default, 1.17 (JDK 17), 1.11 (JDK 11), 1.10 (JDK 10 (niet ondersteund)), 1.9 (JDK 9 (niet ondersteund)), 1.8 (JDK 8), 1.7 (JDK 7), 1.6 (JDK 6 (niet ondersteund)). Standaardwaarde: default.

Probeert het pad naar de geselecteerde JDK-versie te detecteren en JAVA_HOME dienovereenkomstig in te stellen.

jdkDirectory - JDK-pad
Invoeralias: jdkUserInputPath. string. Vereist wanneer javaHomeSelection = Path.

Hiermee stelt u JAVA_HOME in op het opgegeven pad.

jdkArchitectureOption - JDK-architectuur
Invoeralias: jdkArchitecture. string. Facultatief. Gebruiken wanneer jdkVersion != default. Toegestane waarden: x86, x64. Standaardwaarde: x64.

Levert de JDK-architectuur (x86 of x64).

gradleOptions - GRADLE_OPTS instellen
Invoeralias: gradleOpts. string. Standaardwaarde: -Xmx1024m.

Hiermee stelt u de GRADLE_OPTS omgevingsvariabele in, die wordt gebruikt om opdrachtregelargumenten te verzenden om de JVM te starten. De vlag xmx geeft het maximale geheugen aan dat beschikbaar is voor de JVM.

sonarQubeRunAnalysis - SonarQube- of SonarCloud-analyse uitvoeren
Invoeralias: sqAnalysisEnabled. boolean. Standaardwaarde: false.

Deze optie is gewijzigd van versie 1 van de Gradle- taak om de SonarQube- en SonarCloud Marketplace-extensies te gebruiken. Schakel deze optie in om SonarQube- of SonarCloud-analyse uit te voeren na het uitvoeren van taken in het veld Taken. U moet ook een Analyseconfiguratie voorbereiden taak toevoegen van een van de extensies aan de build-pijplijn voordat deze Gradle-taak wordt uitgevoerd.

sqGradlePluginVersionChoice - SonarQube-scanner voor Gradle-versie
string. Vereist wanneer sqAnalysisEnabled = true. Toegestane waarden: specify (versienummer opgeven), build (Invoegtoepassing gebruiken die is toegepast in uw build.gradle). Standaardwaarde: specify.

Hiermee geeft u de SonarQube Gradle-invoegtoepassingsversie op die moet worden gebruikt. Declareer de versie in het Gradle-configuratiebestand of geef een versie op met deze tekenreeks.

sonarQubeGradlePluginVersion - SonarQube-scanner voor gradle-invoegtoepassingsversie
Invoeralias: sqGradlePluginVersion. string. Vereist wanneer sqAnalysisEnabled = true && sqGradlePluginVersionChoice = specify. Standaardwaarde: 2.6.1.

Bevat het versienummer van de SonarQube Gradle-invoegtoepassing.

checkStyleRunAnalysis - Run Checkstyle-
Invoeralias: checkstyleAnalysisEnabled. boolean. Standaardwaarde: false.

Hiermee voert u het hulpprogramma Checkstyle uit met de standaard Sun-controles. Resultaten worden geüpload als buildartefacten.

findBugsRunAnalysis - Run FindBugs
Invoeralias: findbugsAnalysisEnabled. boolean. Standaardwaarde: false.

Maakt gebruik van het hulpprogramma Voor statische analyse van FindBugs om te zoeken naar fouten in de code. Resultaten worden geüpload als buildartefacten. In Gradle 6.0 is deze invoegtoepassingverwijderd. Gebruik in plaats daarvan de SpotBugs-invoegtoepassing.

pmdRunAnalysis - PMD- uitvoeren
Invoeralias: pmdAnalysisEnabled. boolean. Standaardwaarde: false.

Maakt gebruik van het hulpprogramma voor statische analyse van PMD Java om te zoeken naar fouten in de code. De resultaten worden geüpload als buildartefacten.

spotBugsAnalysis - SpotBugs uitvoeren
Invoeralias: spotBugsAnalysisEnabled. boolean. Standaardwaarde: false.

Wordt spotBugs uitgevoerd wanneer true. Deze invoegtoepassing werkt met Gradle v5.6 of hoger. Meer informatie over met behulp van de SpotBugs Gradle-invoegtoepassing. De invoegtoepassing werkt mogelijk op een onverwachte manier of werkt helemaal niet met een eerdere Gradle-versie.

spotBugsGradlePluginVersionChoice - versie van de Spotbugs-invoegtoepassing
string. Vereist wanneer spotBugsAnalysisEnabled = true. Toegestane waarden: specify (versienummer opgeven), build (Invoegtoepassing gebruiken die is toegepast in uw build.gradle). Standaardwaarde: specify.

Hiermee geeft u de versie van de SpotBugs Gradle-invoegtoepassing te gebruiken. De versie kan worden gedeclareerd in het Gradle-configuratiebestand of de versie kan worden opgegeven in deze tekenreeks.

spotbugsGradlePluginVersion - versienummer
string. Vereist wanneer spotBugsAnalysisEnabled = true && spotBugsGradlePluginVersionChoice = specify. Standaardwaarde: 4.7.0.

Bevat het versienummer van de SpotBugs Gradle-invoegtoepassing.

Opties voor taakbeheer

Alle taken hebben besturingsopties naast hun taakinvoer. Zie Opties en algemene taakeigenschappenvoor meer informatie.

Uitvoervariabelen

Geen.

Opmerkingen

Notitie

Er is een nieuwere versie van deze taak beschikbaar op Gradle@3.

De configuratie van de SonarQube-analyse is verplaatst naar de SonarQube- of SonarCloud-extensies in de Prepare Analysis Configuration-taak.

Gebruik deze taak om te bouwen met behulp van een Gradle wrapper-script.

Hoe genereer ik een wrapper van mijn Gradle-project?

Met de Gradle-wrapper kan de buildagent de exacte Gradle-omgeving downloaden en configureren die is ingecheckt in de opslagplaats zonder dat er softwareconfiguratie is op de buildagent zelf dan de JVM.

1. Maak de Gradle-wrapper door de volgende opdracht uit te geven uit de hoofdmap van het project waarin uw build.gradle zich bevindt:

   jamal@fabrikam> gradle wrapper

2. Upload uw Gradle-wrapper naar uw externe opslagplaats.

   Er is een binair artefact dat wordt gegenereerd door de gradle wrapper (op gradle/wrapper/gradle-wrapper.jar). Dit binaire bestand is klein en hoeft niet te worden bijgewerkt. Als u de Gradle-configuratie wilt wijzigen die wordt uitgevoerd op de buildagent, werkt u de gradle-wrapper.propertiesbij.

   De opslagplaats moet er ongeveer als volgt uitzien:

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

Hoe los ik time-outs op bij het downloaden van afhankelijkheden?

Om fouten zoals Read timed out bij het downloaden van afhankelijkheden op te lossen, kunnen gebruikers van Gradle 4.3+ de time-out wijzigen door -Dhttp.socketTimeout=60000 -Dhttp.connectionTimeout=60000 toe te voegen aan Options. Dit verhoogt de time-out van 10 seconden tot 1 minuut.

Voorbeelden

Uw Java-app bouwen met Gradle

Vereisten

Voorwaarde	Beschrijving
Pijplijntypen	YAML, klassieke build
Wordt uitgevoerd op	Agent, DeploymentGroup
eisen	Zelf-hostende agents moeten mogelijkheden hebben die overeenkomen met de volgende eisen om taken uit te voeren die deze taak gebruiken: java:
mogelijkheden	Deze taak voldoet niet aan de vereisten voor volgende taken in de taak.
opdrachtbeperkingen	Welk dan ook
variabelen instellen	Welk dan ook
Agentversie	1.91.0 of hoger
Taakcategorie	Bouwen