Partager via


Ant@1 - Tâche Ant v1

Utilisez cette tâche pour générer avec Apache Ant.

Syntax

# Ant v1
# Build with Apache Ant.
- task: Ant@1
  inputs:
    buildFile: 'build.xml' # string. Alias: antBuildFile. Required. Ant build file. Default: build.xml.
    #options: # string. Options. 
    #targets: # string. Target(s). 
  # 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
    #codeCoverageToolOptions: 'None' # 'None' | 'Cobertura' | 'JaCoCo'. Alias: codeCoverageTool. Code coverage tool. Default: None.
    codeCoverageClassFilesDirectories: '.' # string. Alias: classFilesDirectories. Required when codeCoverageTool != None. Class files directories. Default: ..
    #codeCoverageClassFilter: # string. Alias: classFilter. Optional. Use when codeCoverageTool != None. Class inclusion/exclusion filters. 
    #codeCoverageSourceDirectories: # string. Alias: srcDirectories. Optional. Use when codeCoverageTool != None. Source files directories. 
    #codeCoverageFailIfEmpty: false # boolean. Alias: failIfCoverageEmpty. Optional. Use when codeCoverageTool != None. Fail when code coverage results are missing. Default: false.
  # Advanced
    #antHomeDirectory: # string. Alias: antHomeUserInputPath. Set ANT_HOME path. 
    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.
    #jdkUserInputDirectory: # string. Alias: jdkUserInputPath. Required when javaHomeSelection = Path. JDK path. 
    #jdkArchitectureOption: 'x64' # 'x86' | 'x64'. Alias: jdkArchitecture. Optional. Use when jdkVersion != default. JDK architecture. Default: x64.
# Ant v1
# Build with Apache Ant.
- task: Ant@1
  inputs:
    buildFile: 'build.xml' # string. Alias: antBuildFile. Required. Ant build file. Default: build.xml.
    #options: # string. Options. 
    #targets: # string. Target(s). 
  # JUnit Test Results
    #publishJUnitResults: true # boolean. Publish to Azure Pipelines/TFS. 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
    #codeCoverageToolOptions: 'None' # 'None' | 'Cobertura' | 'JaCoCo'. Alias: codeCoverageTool. Code coverage tool. Default: None.
    codeCoverageClassFilesDirectories: '.' # string. Alias: classFilesDirectories. Required when codeCoverageTool != None. Class files directories. Default: ..
    #codeCoverageClassFilter: # string. Alias: classFilter. Optional. Use when codeCoverageTool != None. Class inclusion/exclusion filters. 
    #codeCoverageSourceDirectories: # string. Alias: srcDirectories. Optional. Use when codeCoverageTool != None. Source files directories. 
    #codeCoverageFailIfEmpty: false # boolean. Alias: failIfCoverageEmpty. Optional. Use when codeCoverageTool != None. Fail when code coverage results are missing. Default: false.
  # Advanced
    #antHomeDirectory: # string. Alias: antHomeUserInputPath. Set ANT_HOME path. 
    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.
    #jdkUserInputDirectory: # string. Alias: jdkUserInputPath. Required when javaHomeSelection = Path. JDK path. 
    #jdkArchitectureOption: 'x64' # 'x86' | 'x64'. Alias: jdkArchitecture. Optional. Use when jdkVersion != default. JDK architecture. Default: x64.

Entrées

buildFile - Fichier de build Ant
Alias d’entrée : antBuildFile. string. Obligatoire. Valeur par défaut : build.xml.

Chemin d’accès relatif de la racine du dépôt au fichier de build Ant.

Pour plus d’informations sur les fichiers de build, consultez Utilisation d’Apache Ant.


options - Options
string.

Fournit des options à passer à la ligne de commande Ant. Vous pouvez fournir vos propres propriétés (par exemple, -DmyProperty=myPropertyValue) et également utiliser des variables intégrées (par exemple, -DcollectionId=$(system.collectionId)). Les variables intégrées sont également déjà définies comme variables d’environnement pendant la génération et peuvent être transmises directement (par exemple, -DcollectionIdAsEnvVar=%SYSTEM_COLLECTIONID%).

Consultez Exécution d’Apache Ant.


targets - Cible(s)
string.

Liste facultative de cibles à générer, séparées par des espaces. Si elle n’est pas spécifiée, la default cible est utilisée. Si aucune cible n’est default définie, Ant 1.6.0 et ultérieur génère toutes les tâches de niveau supérieur.

Consultez l’utilisation de cibles Apache Ant.


publishJUnitResults - Publier sur Azure Pipelines
boolean. Valeur par défaut : true.

Sélectionnez cette option pour publier les résultats des tests JUnit produits par la build Ant sur Azure Pipelines. Chaque fichier de résultats de test correspondant à Test Results Files sera publié en tant que série de tests dans Azure Pipelines.


publishJUnitResults - Publier sur Azure Pipelines/TFS
boolean. Valeur par défaut : true.

Sélectionnez cette option pour publier les résultats des tests JUnit produits par la build Ant sur Azure Pipelines. Chaque fichier de résultats de test correspondant à Test Results Files sera publié en tant que série de tests dans Azure Pipelines.


testResultsFiles - Fichiers de résultats de test
string. Nécessaire lorsque publishJUnitResults = true. Valeur par défaut : **/TEST-*.xml.

Chemin du fichier de résultats de test. Des caractères génériques peuvent être utilisés. Pour plus d’informations, consultez la référence des modèles de correspondance de fichier. Par exemple, **/TEST-*.xml pour tous les fichiers XML dont le nom commence par TEST-.


testRunTitle - Titre de la série de tests
string. facultatif. Utilisez quand publishJUnitResults = true.

Fournit un nom pour la série de tests.


codeCoverageToolOptions - Outil de couverture du code
Alias d’entrée : codeCoverageTool. string. Valeurs autorisées : None, Cobertura, JaCoCo. Valeur par défaut : None.

Sélectionne l’outil de couverture du code.

Si vous utilisez les agents hébergés par Microsoft, les outils sont configurés pour vous. Si vous utilisez l’agent Windows local, vous devez vous assurer que l’agent est configuré pour JaCoco ou Cobertura.

  • JaCoCo : vérifiez que jacocoant.jar est disponible dans le dossier lib de l’installation d’Ant. En savoir plus sur les tâches JaCoCo Ant.
  • Cobertura : vérifiez qu’une variable d’environnement COBERTURA_HOME pointe vers l’emplacement des fichiers .jar Cobertura. En savoir plus sur Cobertura avec les tâches Ant.

Après avoir sélectionné l’un de ces outils, les arguments suivants s’affichent :


codeCoverageClassFilesDirectories - Répertoires de fichiers de classe
Alias d’entrée : classFilesDirectories. string. Nécessaire lorsque codeCoverageTool != None. Valeur par défaut : ..

Liste séparée par des virgules des chemins d’accès relatifs du fichier de build Ant aux répertoires contenant des fichiers de classe et des fichiers d’archive (.jar, .war, etc.). La couverture du code est signalée pour les fichiers de classe de ces répertoires. Par exemple : target/classes,target/testClasses.


codeCoverageClassFilter - Filtres d’inclusion/d’exclusion de classe
Alias d’entrée : classFilter. string. facultatif. Utilisez quand codeCoverageTool != None.

Liste de filtres séparés par des virgules pour inclure ou exclure des classes de la collecte de la couverture du code. Par exemple : +:com., +:org., -:my.app*..


codeCoverageSourceDirectories - Répertoires de fichiers sources
Alias d’entrée : srcDirectories. string. facultatif. Utilisez quand codeCoverageTool != None.

Liste séparée par des virgules des chemins d’accès relatifs du fichier de build Ant aux répertoires de code source. Les rapports de couverture du code les utilisent pour mettre en évidence le code source. Par exemple : src/java,src/Test.


codeCoverageFailIfEmpty - Échec lorsque les résultats de la couverture du code sont manquants
Alias d’entrée : failIfCoverageEmpty. boolean. facultatif. Utilisez quand codeCoverageTool != None. Valeur par défaut : false.

La génération échoue si la couverture du code n’a pas produit de résultats à publier.


antHomeDirectory - Définir ANT_HOME chemin
Alias d’entrée : antHomeUserInputPath. string.

Si cette option est définie, remplace toute variable d’environnement ANT_HOME existante par le chemin d’accès donné.


javaHomeOption - Définir JAVA_HOME par
Alias d’entrée : javaHomeSelection. string. Obligatoire. Valeurs autorisées : JDKVersion (version JDK), Path. Valeur par défaut : JDKVersion.

Définit JAVA_HOME en sélectionnant une version du JDK qui sera découverte pendant les builds ou en entrant manuellement un chemin DDK.


jdkVersionOption - Version du JDK
Alias d’entrée : jdkVersion. string. facultatif. Utilisez quand javaHomeSelection = JDKVersion. Valeurs autorisées : default, 1.11 (JDK 11), 1.10 (JDK 10 (hors support)), 1.9 (JDK 9 (hors support)), 1.8 (JDK 8), 1.7 (JDK 7), 1.6 (JDK 6 (hors support)). Valeur par défaut : default.

Tente de découvrir le chemin d’accès à la version du JDK sélectionnée et définit JAVA_HOME en conséquence.


jdkUserInputDirectory - Chemin JDK
Alias d’entrée : jdkUserInputPath. string. Nécessaire lorsque javaHomeSelection = Path.

Définit JAVA_HOME au chemin d’accès donné.


jdkArchitectureOption - Architecture JDK
Alias d’entrée : jdkArchitecture. string. facultatif. Utilisez quand jdkVersion != default. Valeurs autorisées : x86, x64. Valeur par défaut : x64.

Fournit éventuellement l’architecture (x86, x64) du JDK.


Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

Utilisez cette tâche pour générer avec Apache Ant.

Configuration requise

Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Agent, DeploymentGroup
Demandes Les agents auto-hébergés doivent avoir des fonctionnalités qui correspondent aux exigences suivantes pour exécuter des travaux qui utilisent cette tâche : ant
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commandes Quelconque
Variables settables Quelconque
Version de l’agent 1.89.0 ou version ultérieure
Catégorie de la tâche Build