DownloadPipelineArtifact@2 — pobieranie artefaktów potoku w wersji 2

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

Uwaga / Notatka

Aby uzyskać więcej informacji, w tym poleceń interfejsu wiersza polecenia platformy Azure, zobacz pobierania 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
Alias wejściowy: source. string. To jest wymagane. Dozwolone wartości: current (bieżący przebieg), specific (określone uruchomienie). Wartość domyślna: current.

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

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

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

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

Identyfikator definicji potoku. W uruchomionym potoku definitionId można znaleźć w zmiennej System.DefinitionId. 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 definitionId wynosi 78: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build?definitionId=78&_a=summary. Aby pobrać artefakty z określonej definicji potoku, przechwyć definitionId z tego potoku i określić je jako parametr pipeline.

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 wyzwalającej 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 (najnowsze 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 - Tworzenie
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. 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 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 z tego uruchomienia i określ je jako parametr buildId.

tags - tagów 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 - Pobieranie artefaktów z częściowo zakończonych powodzeniem kompilacji.
boolean. Opcjonalny. Użyj polecenia , gdy source == specific && runVersion != specific. Wartość domyślna: false.

Określa, czy pobierać artefakty z częściowo zakończonych powodzeniem kompilacji. W tym celu należy ustawić wartość i allowPartiallySucceededBuildsallowFailedBuilds na true.

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.

Określa, czy mają być pobierane artefakty z kompilacji, które zakończyły się 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 dopasowania plików, które ograniczają pobrane pliki. Wartość może być co najmniej jednym wzorcem dopasowywania plików, które są rozdzielane nowym wierszem. Dowiedz się więcej o wzorcach dopasowywania plików .

W przeciwieństwie do innych zadań, to zadanie spowoduje pobranie pliku pasującego do dowolnego wzorca. Wzorce wykluczania nie mogą być używane do wykluczania wcześniej dołączonych plików i będą zawierać pliki, które nie pasują do żadnych wzorców dołączania.

katalogu docelowego
Alias wejściowy: path | downloadPath. string. To jest wymagane. Wartość domyślna: $(Pipeline.Workspace).

Określa ścieżkę względną lub bezwzględną 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ń podrzędnych. 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 usługach Azure DevOps Services. Jeśli używasz go na serwerze 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. Użyj pobierz artefakty kompilacji, jeśli używasz serwera 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)programu . Jeśli nie określisz nazwy artefaktu, dla każdego pobranego artefaktu zostanie utworzony podkatalog. Aby ograniczyć pliki, które chcesz pobrać, można użyć wzorców dopasowywania plików.

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 definicji dla określonej definicji potoku

W uruchomionym potoku definitionId można znaleźć w zmiennej System.DefinitionId. 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 definitionId wynosi 78: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build?definitionId=78&_a=summary. Aby pobrać artefakty z określonej definicji potoku, przechwyć definitionId z tego potoku i określić je jako parametr pipeline.

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

Identyfikator przebiegu potoku, z którego mają zostać pobrane artefakty. W uruchomionym potoku buildId można znaleźć w zmiennej Build.BuildId. 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 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 z tego uruchomienia i określ je jako parametr buildId.

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 na	Agent, grupa wdrożeniowa
Wymagania	Żaden
Możliwości	To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
ograniczenia poleceń	Jakikolwiek
Zmienne ustawialne	Jakikolwiek
Wersja agenta	2.164.1 lub nowsza
Kategoria zadań	Użyteczność