DownloadPipelineArtifact@2 — pobieranie zadania Artefakty potoku w wersji 2

To zadanie służy do pobierania artefaktów potoku z wcześniejszych etapów w tym potoku lub z innego potoku.

Uwaga

Aby uzyskać więcej informacji, w tym poleceń interfejsu wiersza polecenia platformy Azure, zobacz pobieranie artefaktów.

Składnia

# Download Pipeline Artifacts v2
# Download build and pipeline artifacts.
- task: DownloadPipelineArtifact@2
  inputs:
    buildType: 'current' # 'current' | 'specific'. Alias: source. Required. Download artifacts produced by. Default: current.
    #project: # string. Required when source == specific. Project. 
    #definition: # string. Alias: pipeline. Required when source == specific. Build pipeline. 
    #specificBuildWithTriggering: false # boolean. Alias: preferTriggeringPipeline. Optional. Use when source == specific. When appropriate, download artifacts from the triggering build. Default: false.
    #buildVersionToDownload: 'latest' # 'latest' | 'latestFromBranch' | 'specific'. Alias: runVersion. Required when source == specific. Build version to download. Default: latest.
    #branchName: 'refs/heads/master' # string. Alias: runBranch. Required when source == specific && runVersion == latestFromBranch. Branch name. Default: refs/heads/master.
    #pipelineId: # string. Alias: runId | buildId. Required when source == specific && runVersion == specific. Build. 
    #tags: # string. Optional. Use when source == specific && runVersion != specific. Build Tags. 
    #allowPartiallySucceededBuilds: false # boolean. Optional. Use when source == specific && runVersion != specific. Download artifacts from partially succeeded builds. Default: false.
    #allowFailedBuilds: false # boolean. Optional. Use when source == specific && runVersion != specific. Download artifacts from failed builds. Default: false.
    #artifactName: # string. Alias: artifact. Artifact name. 
    #itemPattern: '**' # string. Alias: patterns. Matching patterns. Default: **.
    targetPath: '$(Pipeline.Workspace)' # string. Alias: path | downloadPath. Required. Destination directory. Default: $(Pipeline.Workspace).

Dane wejściowe

buildType - Pobieranie artefaktów utworzonych przez firmę
Alias wejściowy: source. string. Wymagane. Dozwolone wartości: current (bieżący przebieg), specific (określone uruchomienie). Wartość domyślna: current.

Pobiera artefakty wygenerowane przez bieżące uruchomienie potoku lub z określonego uruchomienia potoku.

project - Projektu
string. Wymagane, gdy source == specific.

Określa nazwę projektu lub identyfikator GUID, z którego mają być pobierane artefakty potoku.

definition - Potok kompilacji
Alias wejściowy: pipeline. string. Wymagane, gdy source == specific.

Identyfikator definicji potoku. W uruchomionym potoku definitionId można znaleźć w zmiennej System.DefinitionId . Plik definitionId można również pobrać z adresu URL na stronie przeglądu potoku w portalu usługi Azure DevOps. W poniższym przykładzie definitionId adresu URL wartość to 78: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build?definitionId=78&_a=summary. Aby pobrać artefakty z określonej definicji potoku, przechwyć definitionId element z tego potoku i określić go jako pipeline parametr.

specificBuildWithTriggering - W razie potrzeby pobierz artefakty z kompilacji wyzwalającej.
Alias wejściowy: preferTriggeringPipeline. boolean. Opcjonalny. Użyj polecenia , gdy source == specific. Wartość domyślna: false.

Jeśli to pole wyboru, zadanie pobiera artefakty z kompilacji wyzwalającej. Jeśli nie ma wyzwalania kompilacji z określonego potoku, zadanie pobiera artefakty z kompilacji określonej w poniższych opcjach.

buildVersionToDownload - Wersja kompilacji do pobrania
Alias wejściowy: runVersion. string. Wymagane, gdy source == specific. Dozwolone wartości: latest, latestFromBranch (najnowsza z określonej gałęzi i określone tagi kompilacji), specific (określona wersja). Wartość domyślna: latest.

Określa wersję kompilacji do pobrania.

branchName - Nazwa gałęzi
Alias wejściowy: runBranch. string. Wymagane, gdy source == specific && runVersion == latestFromBranch. Wartość domyślna: refs/heads/master.

Określa filtr dla gałęzi/nazwy ref. Na przykład: refs/heads/develop.

pipelineId - Budować
Alias wejściowy: runId | buildId. string. Wymagane, gdy source == specific && runVersion == specific.

Identyfikator przebiegu potoku, z którego mają zostać pobrane artefakty. W uruchomionym potoku buildId można znaleźć w zmiennej Build.BuildId . Plik buildId można również pobrać z adresu URL na stronie podsumowania przebiegu potoku w portalu usługi Azure DevOps. W poniższym przykładzie buildId adresu URL wartość to 1088: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build/results?buildId=1088&view=results. Aby pobrać artefakty z określonego przebiegu potoku, przechwyć buildId element z tego uruchomienia i określ go jako buildId parametr.

tags - Tagi kompilacji
string. Opcjonalny. Użyj polecenia , gdy source == specific && runVersion != specific.

Rozdzielana przecinkami lista tagów używanych przez zadanie do zwracania otagowanych kompilacji. Nie są zwracane nieoznaczone kompilacje.

allowPartiallySucceededBuilds - Pobierz artefakty z częściowo zakończonych powodzeniem kompilacji.
boolean. Opcjonalny. Użyj polecenia , gdy source == specific && runVersion != specific. Wartość domyślna: false.

Określa, czy zadanie kompilacji pobiera artefakty, czy kompilacja zakończy się powodzeniem, czy częściowo zakończy się powodzeniem.

allowFailedBuilds - Pobieranie artefaktów z kompilacji, które zakończyły się niepowodzeniem.
boolean. Opcjonalny. Użyj polecenia , gdy source == specific && runVersion != specific. Wartość domyślna: false.

Jeśli to pole wyboru, zadanie kompilacji pobiera artefakty, czy kompilacja zakończy się powodzeniem, czy niepowodzeniem.

artifactName - Nazwa artefaktu
Alias wejściowy: artifact. string.

Określa nazwę artefaktu do pobrania. Jeśli wartość jest pozostawiona pusta, zadanie pobiera wszystkie artefakty skojarzone z uruchomieniem potoku.

itemPattern - Pasujące wzorce
Alias wejściowy: patterns. string. Wartość domyślna: **.

Wzorce dopasowywania plików, które ograniczają pobrane pliki. Wartość może być co najmniej jednym wzorcem dopasowywania plików, które są rozdzielane nowymi wierszami. Dowiedz się więcej o wzorcach dopasowywania plików.

targetPath - Katalog docelowy
Alias wejściowy: path | downloadPath. string. Wymagane. Wartość domyślna: $(Pipeline.Workspace).

Określa względną lub bezwzględną ścieżkę na maszynie agenta, na której będą pobierane artefakty. Jeśli zostanie zastosowana opcja wielokrotnego pobierania (pozostawiając pustą nazwę artefaktu), zostanie utworzony podkatalog dla każdego pobierania. Dowiedz się więcej o artefaktach w usłudze Azure Pipelines.

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

To zadanie definiuje następujące zmienne wyjściowe, które można używać w krokach podrzędnych, zadaniach i etapach.

BuildNumber
Przechowuje numer kompilacji źródła artefaktu potoku.

Ze względu na zgodność z poprzednimi wersjami ta zmienna zwraca wartość BuildId.

Dowiedz się więcej o zmiennych kompilacji.

Uwagi

Ważne

To zadanie jest obsługiwane tylko w Azure DevOps Services. Jeśli używasz go w Azure DevOps Server, zostanie wyświetlony komunikat o błędzie podobny do Pipeline Artifact Task is not supported in on-premises. Please use Build Artifact Task instead. use Download Build Artifacts if you're using Azure DevOps Server or TFS 2018(Użyj pobierania artefaktów kompilacji), jeśli używasz Azure DevOps Server lub TFS 2018.

To zadanie służy do pobierania artefaktów potoku z wcześniejszych etapów tego potoku lub z innego potoku. Domyślnie artefakty są pobierane do .$(Pipeline.Workspace) Jeśli nie określisz nazwy artefaktu, dla każdego pobranego artefaktu zostanie utworzony podkatalog. Możesz użyć wzorców dopasowywania plików , aby ograniczyć pliki, które chcesz pobrać.

Słowa kluczowe publikowania i pobierania to skróty zadań do publikowania i pobierania artefaktów potoku.

Jak mogę znaleźć identyfikator potoku, z którego chcę pobrać artefakt?

Aby znaleźć identyfikator definitionId dla określonej definicji potoku

W uruchomionym potoku definitionId element można znaleźć w zmiennej System.DefinitionId . Element definitionId można również pobrać z adresu URL na stronie przeglądu potoku w portalu usługi Azure DevOps. W poniższym przykładzie adresu URL wartość definitionId to 78: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build?definitionId=78&_a=summary. Aby pobrać artefakty z określonej definicji potoku, przechwyć definitionId element z tego potoku i określić go jako pipeline parametr.

Aby znaleźć identyfikator buildId dla określonego uruchomienia potoku

Identyfikator uruchomienia potoku, z którego mają zostać pobrane artefakty. W uruchomionym potoku buildId można znaleźć w zmiennej Build.BuildId . Element buildId można również pobrać z adresu URL na stronie podsumowania przebiegu potoku w portalu usługi Azure DevOps. W poniższym przykładzie adresu URL parametr buildId to 1088: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build/results?buildId=1088&view=results. Aby pobrać artefakty z określonego uruchomienia potoku, przechwyć buildId go z tego uruchomienia i określić jako buildId parametr.

Przykłady

Pobieranie określonego artefaktu

# Download an artifact named 'WebApp' to 'bin' in $(Build.SourcesDirectory)
- task: DownloadPipelineArtifact@2
  inputs:
    artifactName: 'WebApp'
    targetPath: $(Build.SourcesDirectory)/bin

Pobieranie artefaktów z określonego projektu/potoku

# Download artifacts from a specific pipeline.
- task: DownloadPipelineArtifact@2
  inputs:
    buildType: 'specific'
    project: 'FabrikamFiber'
    definition: 12
    buildVersionToDownload: 'latest'

Pobieranie artefaktów z określonej gałęzi

# Download artifacts from a specific branch with a tag
- task: DownloadPipelineArtifact@2
  inputs:
    buildType: 'specific'
    project: 'FabrikamFiber'
    definition: 12
    buildVersionToDownload: 'latestFromBranch'
    branchName: 'refs/heads/master'
    tags: 'testTag'

Pobieranie artefaktu z określonego przebiegu kompilacji

# Download an artifact named 'WebApp' from a specific build run to 'bin' in $(Build.SourcesDirectory)
- task: DownloadPipelineArtifact@2
  inputs:
    buildType: 'specific'
    artifactName: 'WebApp'
    targetPath: $(Build.SourcesDirectory)/bin
    project: 'FabrikamFiber'
    definition: 12
    buildVersionToDownload: 'specific'
    pipelineId: 40

Wymagania

Wymaganie	Opis
Typy potoków	YAML, klasyczna kompilacja, wersja klasyczna
Działa w	Agent, DeploymentGroup
Wymagania	Brak
Możliwości	To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
Ograniczenia poleceń	Dowolne
Zmienne ustawialne	Dowolne
Wersja agenta	2.164.1 lub nowsza
Kategoria zadania	Narzędzie