Gradle@2 - Tarefa Gradle v2

Crie usando um script wrapper Gradle.

Esta versão da tarefa foi preterida; use Gradle@3.

Sintaxe

# 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.

Insumos

gradleWrapperFile - Invólucro Gradle
Alias de entrada: wrapperScript. string. Obrigatório. Valor padrão: gradlew.

Especifica o local do wrapper de gradlew dentro do repositório que será usado para a compilação. Os agentes no Windows (incluindo agentes hospedados pela Microsoft) devem usar o wrapper gradlew.bat. Os agentes no Linux ou macOS podem usar o shell script gradlew. Saiba mais sobre o Gradle Wrapper. Se o wrapper Gradle não estiver no diretório raiz, especifique o caminho para o script wrapper. Por exemplo, subdir/gradlew.

workingDirectory - Diretório de trabalho
Alias de entrada: cwd. string.

Especifica o diretório de trabalho para executar a compilação do Gradle. A tarefa usa o diretório raiz do repositório se o diretório de trabalho não for especificado.

options - Opções
string.

Especifica as opções de linha de comando que serão passadas para o wrapper Gradle. Consulte de linha de comando Gradle para obter mais informações.

tasks - Tarefas
string. Obrigatório. Valor padrão: build.

A(s) tarefa(s) para o Gradle executar. Uma lista de nomes de tarefas deve ser separada por espaços e pode ser retirada de gradlew tasks emitida a partir de um prompt de comando.

Consulte Gradle Build Script Basics para obter mais informações.

publishJUnitResults - Publicar no Azure Pipelines
boolean. Valor padrão: true.

Publica os resultados do teste JUnit produzidos pela compilação Gradle no Azure Pipelines. A tarefa publica cada arquivo de resultados de teste correspondente Test Results Files como uma execução de teste no Azure Pipelines.

testResultsFiles - Arquivos de resultados de teste
string. Necessário quando publishJUnitResults = true. Valor padrão: **/TEST-*.xml.

O caminho do arquivo para os resultados do teste. curingas podem ser usados. Por exemplo, **/TEST-*.xml para todos os arquivos XML cujo nome começa com TEST-.

testRunTitle - Título da execução de teste
string. Opcional. Use quando publishJUnitResults = true.

Fornece um nome para os resultados do caso de teste JUnit para esta compilação.

codeCoverageToolOption - Ferramenta de cobertura de código
Alias de entrada: codeCoverageTool. string. Valores permitidos: None, Cobertura, JaCoCo. Valor padrão: None.

Especifica uma ferramenta de cobertura de código para determinar o código coberto pelos casos de teste para a compilação.

codeCoverageClassFilesDirectories - Diretórios de arquivos de classe
Alias de entrada: classFilesDirectories. string. Necessário quando codeCoverageTool != None. Valor padrão: build/classes/main/.

A lista separada por vírgulas de diretórios contendo arquivos de classe e arquivos (.jar, .war e muito mais). A cobertura de código é relatada para arquivos de classe nesses diretórios. Normalmente, a tarefa pesquisa classes em build/classes/java/main (para Gradle 4+), que é o diretório de classe padrão para compilações Gradle.

codeCoverageClassFilter - Filtros de inclusão/exclusão de classe
Alias de entrada: classFilter. string. Opcional. Use quando codeCoverageTool != None.

A lista separada por vírgulas de filtros para incluir ou excluir classes da cobertura de código de coleta. Por exemplo: +:com.*,+:org.*,-:my.app*.*.

codeCoverageFailIfEmpty - Falha quando os resultados da cobertura de código estão faltando
Alias de entrada: failIfCoverageEmpty. boolean. Opcional. Use quando codeCoverageTool != None. Valor padrão: false.

Falha na compilação se a cobertura do código não produziu nenhum resultado para publicar.

codeCoverageGradle5xOrHigher - Gradle versão >= 5.x
Alias de entrada: gradle5xOrHigher. boolean. Opcional. Use quando codeCoverageTool = JaCoCo. Valor padrão: true.

Defina isso como 'true' se a versão gradle for >= 5.x.

javaHomeOption - set JAVA_HOME por
Alias de entrada: javaHomeSelection. string. Obrigatório. Valores permitidos: JDKVersion (Versão JDK), Path. Valor padrão: JDKVersion.

Define JAVA_HOME selecionando uma versão do JDK que a tarefa descobre durante as compilações ou inserindo manualmente um caminho JDK.

jdkVersionOption - versão JDK
Alias de entrada: jdkVersion. string. Opcional. Use quando javaHomeSelection = JDKVersion. Valores permitidos: default, 1.17 (JDK 17), 1.11 (JDK 11), 1.10 (JDK 10 (sem suporte)), 1.9 (JDK 9 (sem suporte)), 1.8 (JDK 8), 1.7 (JDK 7) 1.6 (JDK 6 (sem suporte)). Valor padrão: default.

Tenta descobrir o caminho para a versão selecionada do JDK e definir JAVA_HOME de acordo.

jdkDirectory - caminho JDK
Alias de entrada: jdkUserInputPath. string. Necessário quando javaHomeSelection = Path.

Define JAVA_HOME para o caminho determinado.

jdkArchitectureOption - arquitetura JDK
Alias de entrada: jdkArchitecture. string. Opcional. Use quando jdkVersion != default. Valores permitidos: x86, x64. Valor padrão: x64.

Fornece a arquitetura JDK (x86 ou x64).

gradleOptions - set GRADLE_OPTS
Alias de entrada: gradleOpts. string. Valor padrão: -Xmx1024m.

Define a variável de ambiente GRADLE_OPTS, que é usada para enviar argumentos de linha de comando para iniciar a JVM. O sinalizador xmx especifica a memória máxima disponível para a JVM.

sonarQubeRunAnalysis - Execute o SonarQube ou o SonarCloud Analysis
Alias de entrada: sqAnalysisEnabled. boolean. Valor padrão: false.

Esta opção foi alterada a partir da versão 1 da tarefa Gradle para usar as extensões de mercado SonarQube e SonarCloud. Habilite esta opção para executar de análise SonarQube ou SonarCloud depois de executar tarefas no campo Tarefas. Você também deve adicionar uma tarefa Preparar Configuração de Análise de uma das extensões para o pipeline de compilação antes dessa tarefa Gradle.

sqGradlePluginVersionChoice - scanner SonarQube para Gradle versão
string. Necessário quando sqAnalysisEnabled = true. Valores permitidos: specify (Especificar número da versão), build (Usar plug-in aplicado em seu build.gradle). Valor padrão: specify.

Especifica a versão do plug-in SonarQube Gradle a ser usada. Declare a versão no arquivo de configuração do Gradle ou especifique uma versão com essa cadeia de caracteres.

sonarQubeGradlePluginVersion - SonarQube scanner para Gradle plugin versão
Alias de entrada: sqGradlePluginVersion. string. Necessário quando sqAnalysisEnabled = true && sqGradlePluginVersionChoice = specify. Valor padrão: 2.6.1.

Contém o número da versão do plugin SonarQube Gradle.

checkStyleRunAnalysis - Executar Checkstyle
Alias de entrada: checkstyleAnalysisEnabled. boolean. Valor padrão: false.

Executa a ferramenta Checkstyle com as verificações Sun padrão. Os resultados são carregados como artefatos de construção.

findBugsRunAnalysis - Executar FindBugs
Alias de entrada: findbugsAnalysisEnabled. boolean. Valor padrão: false.

Usa a ferramenta de análise estática FindBugs para procurar bugs no código. Os resultados são carregados como artefatos de construção. No Gradle 6.0, este plugin foi removido. Use o plugin SpotBugs em vez disso.

pmdRunAnalysis - Executar PMD
Alias de entrada: pmdAnalysisEnabled. boolean. Valor padrão: false.

Usa a ferramenta de análise estática Java PMD para procurar bugs no código. Os resultados são carregados como artefatos de construção.

spotBugsAnalysis - Executar SpotBugs
Alias de entrada: spotBugsAnalysisEnabled. boolean. Valor padrão: false.

Executa spotBugs quando true. Este plugin funciona com Gradle v5.6 ou posterior. Saiba mais sobre usando o plugin SpotBugs Gradle. O plugin pode funcionar de forma inesperada ou pode não funcionar de todo com uma versão anterior do Gradle.

spotBugsGradlePluginVersionChoice - Versão do plugin Spotbugs
string. Necessário quando spotBugsAnalysisEnabled = true. Valores permitidos: specify (Especificar número da versão), build (Usar plug-in aplicado em seu build.gradle). Valor padrão: specify.

Especifica a versão do plug-in SpotBugs Gradle a ser usada. A versão pode ser declarada no arquivo de configuração do Gradle ou a versão pode ser especificada nesta cadeia de caracteres.

spotbugsGradlePluginVersion - Número da versão
string. Necessário quando spotBugsAnalysisEnabled = true && spotBugsGradlePluginVersionChoice = specify. Valor padrão: 4.7.0.

Contém o número da versão do plugin SpotBugs Gradle.

Opções de controlo de tarefas

Todas as tarefas têm opções de controle, além de suas entradas de tarefas. Para obter mais informações, consulte Opções de controle de e propriedades de tarefas comuns.

Variáveis de saída

Nenhum.

Observações

Observação

Existe uma versão mais recente desta tarefa disponível em Gradle@3.

A configuração da análise SonarQube foi transferida para as extensões SonarQube ou SonarCloud na tarefa Prepare Analysis Configuration.

Use esta tarefa para criar usando um script wrapper Gradle.

Como faço para gerar um wrapper do meu projeto Gradle?

O wrapper Gradle permite que o agente de compilação baixe e configure o ambiente exato do Gradle que é verificado no repositório sem ter nenhuma configuração de software no próprio agente de compilação além da JVM.

1. Crie o wrapper Gradle emitindo o seguinte comando a partir do diretório raiz do projeto onde reside o build.gradle:

   jamal@fabrikam> gradle wrapper

2. Carregue seu wrapper Gradle para seu repositório remoto.

   Há um artefato binário que é gerado pelo invólucro gradle (localizado em gradle/wrapper/gradle-wrapper.jar). Este arquivo binário é pequeno e não requer atualização. Se precisar alterar a configuração do Gradle executada no agente de compilação, atualize o gradle-wrapper.properties.

   O repositório deve ter esta aparência:

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

Como faço para corrigir tempos limite ao baixar dependências?

Para corrigir erros como Read timed out ao baixar dependências, os usuários do Gradle 4.3+ podem alterar o tempo limite adicionando -Dhttp.socketTimeout=60000 -Dhttp.connectionTimeout=60000 ao Options. Isso aumenta o tempo limite de 10 segundos para 1 minuto.

Exemplos

Crie seu aplicativo Java com o Gradle

Requerimentos

Requisito	Descrição
Tipos de pipeline	YAML, construção clássica
Funciona em	Agente, DeploymentGroup
Exigências	Os agentes auto-hospedados devem ter recursos que correspondam às seguintes demandas executar trabalhos que usam essa tarefa: java
Capacidades	Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes no trabalho.
Restrições de comando	Qualquer
Variáveis configuráveis	Qualquer
Versão do agente	1.91.0 ou superior
Categoria de tarefa	Construir