Ant@1 — zadanie Ant w wersji 1

To zadanie służy do kompilowania za pomocą narzędzia Apache Ant.

Składnia

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

Dane wejściowe

buildFile - Plik kompilacji Ant
Alias wejściowy: antBuildFile. string. Wymagane. Wartość domyślna: build.xml.

Ścieżka względna z katalogu głównego repozytorium do pliku kompilacji Ant.

Aby uzyskać więcej informacji na temat plików kompilacji, zobacz Using Apache Ant (Używanie narzędzia Apache Ant).


options - Opcje
string.

Udostępnia opcje przekazywania do wiersza polecenia Ant. Możesz podać własne właściwości (na przykład -DmyProperty=myPropertyValue), a także użyć wbudowanych zmiennych (na przykład -DcollectionId=$(system.collectionId)). Alternatywnie wbudowane zmienne są już ustawione jako zmienne środowiskowe podczas kompilacji i mogą być przekazywane bezpośrednio (na przykład -DcollectionIdAsEnvVar=%SYSTEM_COLLECTIONID%).

Zobacz Uruchamianie narzędzia Apache Ant.


targets - Elementy docelowe
string.

Opcjonalna, rozdzielona spacjami lista obiektów docelowych do skompilowania. Jeśli nie zostanie określony, zostanie użyty element docelowy default . Jeśli nie default zdefiniowano elementu docelowego, Ant 1.6.0 i nowsze będą kompilować wszystkie zadania najwyższego poziomu.

Zobacz Używanie obiektów docelowych platformy Apache Ant.


publishJUnitResults - Publikowanie w usłudze Azure Pipelines
boolean. Wartość domyślna: true.

Wybierz tę opcję, aby opublikować wyniki testów JUnit wygenerowane przez kompilację Ant w usłudze Azure Pipelines. Każdy plik Test Results Files wyników testu zostanie opublikowany jako przebieg testu w usłudze Azure Pipelines.


publishJUnitResults - Publikowanie w usłudze Azure Pipelines/TFS
boolean. Wartość domyślna: true.

Wybierz tę opcję, aby opublikować wyniki testów JUnit wygenerowane przez kompilację Ant w usłudze Azure Pipelines. Każdy plik Test Results Files wyników testu zostanie opublikowany jako przebieg testu w usłudze Azure Pipelines.


testResultsFiles - Pliki wyników testów
string. Wymagane, gdy publishJUnitResults = true. Wartość domyślna: **/TEST-*.xml.

Ścieżka pliku wyników testu. Symbole wieloznaczne mogą być używane. Aby uzyskać więcej informacji, zobacz dokumentację wzorców dopasowywania plików. Na przykład **/TEST-*.xml dla wszystkich plików XML, których nazwa zaczyna się od TEST-.


testRunTitle - Tytuł przebiegu testu
string. Opcjonalny. Użyj polecenia , gdy publishJUnitResults = true.

Zawiera nazwę przebiegu testu.


codeCoverageToolOptions - Narzędzie pokrycia kodu
Alias wejściowy: codeCoverageTool. string. Dozwolone wartości: None, , JaCoCoCobertura. Wartość domyślna: None.

Wybiera narzędzie pokrycia kodu.

Jeśli używasz agentów hostowanych przez firmę Microsoft, narzędzia są konfigurowane dla Ciebie. Jeśli używasz lokalnego agenta systemu Windows, musisz upewnić się, że agent został skonfigurowany dla oprogramowania JaCoco lub Cobertura.

  • JaCoCo — upewnij się, że jacocoant.jar jest dostępna w folderze lib instalacji Ant. Dowiedz się więcej o zadaniach JaCoCo Ant.
  • Cobertura — upewnij się, że zmienna środowiskowa COBERTURA_HOME wskazuje lokalizację plików cobertura .jar. Dowiedz się więcej o aplikacji Cobertura z zadaniami Ant.

Po wybraniu jednego z tych narzędzi pojawią się następujące argumenty:


codeCoverageClassFilesDirectories - Katalogi plików klas
Alias wejściowy: classFilesDirectories. string. Wymagane, gdy codeCoverageTool != None. Wartość domyślna: ..

Rozdzielona przecinkami lista ścieżek względnych z pliku kompilacji Ant do katalogów zawierających pliki klas i pliki archiwum (.jar, .waritp.). Pokrycie kodu jest zgłaszane dla plików klas w tych katalogach. Na przykład: target/classes,target/testClasses.


codeCoverageClassFilter - Filtry dołączania/wykluczania klas
Alias wejściowy: classFilter. string. Opcjonalny. Użyj polecenia , gdy codeCoverageTool != None.

Rozdzielona przecinkami lista filtrów do uwzględnienia lub wykluczenia klas ze zbierania pokrycia kodu. Na przykład: +:com., , -:my.app*.+:org..


codeCoverageSourceDirectories - Katalogi plików źródłowych
Alias wejściowy: srcDirectories. string. Opcjonalny. Użyj polecenia , gdy codeCoverageTool != None.

Rozdzielona przecinkami lista ścieżek względnych z pliku kompilacji Ant do katalogów kodu źródłowego. Raporty pokrycia kodu będą używane do wyróżniania kodu źródłowego. Na przykład: src/java,src/Test.


codeCoverageFailIfEmpty - Niepowodzenie, gdy brakuje wyników pokrycia kodu
Alias wejściowy: failIfCoverageEmpty. boolean. Opcjonalny. Użyj polecenia , gdy codeCoverageTool != None. Wartość domyślna: false.

Kompilacja kończy się niepowodzeniem, jeśli pokrycie kodu nie wygenerowało żadnych wyników do opublikowania.


antHomeDirectory - Ustawianie ścieżki ANT_HOME
Alias wejściowy: antHomeUserInputPath. string.

W przypadku ustawienia zastępuje dowolną istniejącą zmienną środowiskową ANT_HOME z daną ścieżką.


javaHomeOption - Ustaw JAVA_HOME według
Alias wejściowy: javaHomeSelection. string. Wymagane. Dozwolone wartości: JDKVersion (wersja zestawu JDK), Path. Wartość domyślna: JDKVersion.

Ustawia JAVA_HOME, wybierając wersję zestawu JDK, która zostanie odnaleziona podczas kompilacji lub ręcznie wprowadzając ścieżkę zestawu JDK.


jdkVersionOption - Wersja zestawu JDK
Alias wejściowy: jdkVersion. string. Opcjonalny. Użyj polecenia , gdy javaHomeSelection = JDKVersion. Dozwolone wartości: default, 1.11 (JDK 11), 1.10 (JDK 10 (brak obsługi)), (JDK 9 (brak obsługi) 1.8 ), 1.9 (JDK 8), (JDK 7), 1.71.6 (JDK 6 (brak obsługi)). Wartość domyślna: default.

Próbuje odnaleźć ścieżkę do wybranej wersji zestawu JDK i odpowiednio ustawi JAVA_HOME.


jdkUserInputDirectory - Ścieżka zestawu JDK
Alias wejściowy: jdkUserInputPath. string. Wymagane, gdy javaHomeSelection = Path.

Ustawia JAVA_HOME na daną ścieżkę.


jdkArchitectureOption - Architektura zestawu JDK
Alias wejściowy: jdkArchitecture. string. Opcjonalny. Użyj polecenia , gdy jdkVersion != default. Dozwolone wartości: x86, x64. Wartość domyślna: x64.

Opcjonalnie dostarcza architekturę (x86, x64) zestawu JDK.


Opcje sterowania zadania

Wszystkie zadania mają opcje sterowania oprócz danych wejściowych zadań. Aby uzyskać więcej informacji, zobacz Opcje sterowania i typowe właściwości zadań.

Zmienne wyjściowe

Brak.

Uwagi

To zadanie służy do kompilowania za pomocą narzędzia Apache Ant.

Wymagania

Wymaganie Opis
Typy potoków YAML, klasyczna kompilacja, wersja klasyczna
Działa w Agent, DeploymentGroup
Wymagania Agenci hostowani samodzielnie muszą mieć możliwości zgodne z następującymi wymaganiami dotyczącymi uruchamiania zadań korzystających z tego zadania:
Możliwości To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
Ograniczenia poleceń Dowolne
Zmienne ustawialne Dowolne
Wersja agenta 1.89.0 lub nowsza
Kategoria zadania Kompilacja