steps.checkout definíció

  • Cikk

A használatával checkout konfigurálhatja, hogy a folyamat hogyan használja a forráskódot.

steps:
- checkout: string # Required as first property. Configures checkout for the specified repository.
  clean: string # If true, run git clean -ffdx followed by git reset --hard HEAD before fetching.
  fetchDepth: string # Depth of Git graph to fetch.
  fetchTags: string # Set to 'true' to sync tags when fetching the repo, or 'false' to not sync tags. See remarks for the default behavior.
  lfs: string # Set to 'true' to download Git-LFS files. Default is not to download them.
  persistCredentials: string # Set to 'true' to leave the OAuth token in the Git config after the initial fetch. The default is not to leave it.
  submodules: string # Set to 'true' for a single level of submodules or 'recursive' to get submodules of submodules. Default is not to fetch submodules.
  path: string # Where to put the repository. The root directory is $(Pipeline.Workspace).
  condition: string # Evaluate this condition expression to determine whether to run this task.
  continueOnError: boolean # Continue running even on failure?
  displayName: string # Human-readable name for the task.
  target: string | target # Environment in which to run this task.
  enabled: boolean # Run this task when the job runs?
  env: # Variables to map into the process's environment.
    string: string # Name/value pairs
  name: string # ID of the step.
  timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.
  retryCountOnTaskFailure: string # Number of retries if the task fails.

steps:
- checkout: string # Required as first property. Configures checkout for the specified repository.
  clean: string # If true, run git clean -ffdx followed by git reset --hard HEAD before fetching.
  fetchDepth: string # Depth of Git graph to fetch.
  lfs: string # Set to 'true' to download Git-LFS files. Default is not to download them.
  persistCredentials: string # Set to 'true' to leave the OAuth token in the Git config after the initial fetch. The default is not to leave it.
  submodules: string # Set to 'true' for a single level of submodules or 'recursive' to get submodules of submodules. Default is not to fetch submodules.
  path: string # Where to put the repository. The root directory is $(Pipeline.Workspace).
  condition: string # Evaluate this condition expression to determine whether to run this task.
  continueOnError: boolean # Continue running even on failure?
  displayName: string # Human-readable name for the task.
  target: string | target # Environment in which to run this task.
  enabled: boolean # Run this task when the job runs?
  env: # Variables to map into the process's environment.
    string: string # Name/value pairs
  name: string # ID of the step.
  timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.
  retryCountOnTaskFailure: string # Number of retries if the task fails.

steps:
- checkout: string # Required as first property. Configures checkout for the specified repository.
  clean: string # If true, run git clean -ffdx followed by git reset --hard HEAD before fetching.
  fetchDepth: string # Depth of Git graph to fetch.
  lfs: string # Set to 'true' to download Git-LFS files. Default is not to download them.
  persistCredentials: string # Set to 'true' to leave the OAuth token in the Git config after the initial fetch. The default is not to leave it.
  submodules: string # Set to 'true' for a single level of submodules or 'recursive' to get submodules of submodules. Default is not to fetch submodules.
  path: string # Where to put the repository. The root directory is $(Pipeline.Workspace).
  condition: string # Evaluate this condition expression to determine whether to run this task.
  continueOnError: boolean # Continue running even on failure?
  displayName: string # Human-readable name for the task.
  target: string | target # Environment in which to run this task.
  enabled: boolean # Run this task when the job runs?
  env: # Variables to map into the process's environment.
    string: string # Name/value pairs
  name: string # ID of the step.
  timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.

steps:
- checkout: string # Required as first property. Whether or not to check out the repository containing this pipeline definition.
  clean: string # If true, run git clean -ffdx followed by git reset --hard HEAD before fetching.
  fetchDepth: string # Depth of Git graph to fetch.
  lfs: string # Set to 'true' to download Git-LFS files. Default is not to download them.
  persistCredentials: string # Set to 'true' to leave the OAuth token in the Git config after the initial fetch. The default is not to leave it.
  submodules: string # Set to 'true' for a single level of submodules or 'recursive' to get submodules of submodules. Default is not to fetch submodules.
  path: string # Where to put the repository. The root directory is $(Pipeline.Workspace).
  condition: string # Evaluate this condition expression to determine whether to run this task.
  continueOnError: boolean # Continue running even on failure?
  displayName: string # Human-readable name for the task.
  enabled: boolean # Run this task when the job runs?
  env: # Variables to map into the process's environment.
    string: string # Name/value pairs
  name: string # ID of the step.
  timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.

steps:
- checkout: string # Required as first property. Whether or not to check out the repository containing this pipeline definition.
  clean: string # If true, run git clean -ffdx followed by git reset --hard HEAD before fetching.
  fetchDepth: string # Depth of Git graph to fetch.
  lfs: string # Set to 'true' to download Git-LFS files. Default is not to download them.
  persistCredentials: string # Set to 'true' to leave the OAuth token in the Git config after the initial fetch. The default is not to leave it.
  submodules: string # Set to 'true' for a single level of submodules or 'recursive' to get submodules of submodules. Default is not to fetch submodules.
  condition: string # Evaluate this condition expression to determine whether to run this task.
  continueOnError: boolean # Continue running even on failure?
  displayName: string # Human-readable name for the task.
  enabled: boolean # Run this task when the job runs?
  env: # Variables to map into the process's environment.
    string: string # Name/value pairs
  name: string # ID of the step.
  timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.

A definícióra hivatkozó definíciók: lépések

Tulajdonságok

checkout Karakterlánc. Első tulajdonságként kötelező megadni.
Konfigurálja a megadott adattár kivételét. Adja meg selfa , noneaz adattár nevét vagy az adattár-erőforrást. További információ: Több adattár megtekintése a folyamatban.

Megjegyzés

Ha nincs checkout jelen lépés, akkor a és az alapértelmezett selfjobs.job.step.checkoutnonejobs.deployment.steps.checkoutértéke.

checkout Karakterlánc. Első tulajdonságként kötelező megadni.
Azt, hogy ki szeretné-e-e nézni a folyamatdefiníciót tartalmazó adattárat. Adja meg a self vagy a értéket none.

clean Karakterlánc.
Ha igaz, a beolvasás előtt futtassa a git clean -ffdx, majd a git reset --hard HEAD parancsot. igaz | Hamis.

fetchDepth Karakterlánc.
A beolvasandó Git-gráf mélysége.

fetchTags Karakterlánc.
A "true" (igaz) értékre állítva szinkronizálhatja a címkéket az adattár beolvasásakor, vagy a "false" (hamis) értékre, hogy ne szinkronizálja a címkéket. Tekintse meg az alapértelmezett viselkedésre vonatkozó megjegyzéseket.

lfs Karakterlánc.
A Git-LFS-fájlok letöltéséhez állítsa a "true" értéket. Az alapértelmezett beállítás, hogy nem tölti le őket.

persistCredentials Karakterlánc.
Állítsa "true" értékre, hogy az OAuth-jogkivonat a Git-konfigurációban maradjon a kezdeti beolvasás után. Az alapértelmezett beállítás az, hogy nem hagyja meg.

submodules Karakterlánc.
Az almodulok almoduljainak lekéréséhez állítsa "true" (igaz) értékre egyetlen almodul vagy "rekurzív" értékre. Az alapértelmezett érték nem az almodulok beolvasása.

path Karakterlánc.
Hová tegye az adattárat? A gyökérkönyvtár a $(Pipeline.Workspace).

condition Karakterlánc.
Értékelje ki ezt a feltételkifejezést annak meghatározásához, hogy szeretné-e futtatni ezt a feladatot.

continueOnErrorlogikai érték.
Továbbra is fut hiba esetén?

displayName Karakterlánc.
A feladat emberi olvasásra alkalmas neve.

targetcél.
Környezet, amelyben a feladatot futtatni szeretné.

enabledlogikai érték.
Futtatja ezt a feladatot a feladat futtatásakor?

env sztringszótár.
A folyamat környezetébe leképezési változók.

name Karakterlánc.
A lépés azonosítója. Elfogadható értékek: [-_A-Za-z0-9]*.

timeoutInMinutes Karakterlánc.
Várjon, amíg a feladat befejeződik, mielőtt a kiszolgáló leáll.

Megjegyzés

A folyamatok feladatszintű időtúllépéssel konfigurálhatók. Ha a feladatszint időtúllépési időköze a lépés befejezése előtt eltelik, a futó feladat (beleértve a lépést is) leáll, még akkor is, ha a lépés hosszabb timeoutInMinutes időközzel van konfigurálva. További információ: Időtúllépések.

retryCountOnTaskFailure Karakterlánc.
Az újrapróbálkozások száma, ha a feladat meghiúsul.

Megjegyzések

Sekély lehívás

Fontos

A 2022. szeptemberi Azure DevOps sprint 209 frissítés után létrehozott új folyamatok alapértelmezés szerint engedélyezve vannak, és 1 mélységben vannak konfigurálva. Korábban az alapértelmezett érték nem volt sekély lehívás. A folyamat ellenőrzéséhez tekintse meg a Sekély beolvasás beállítást a folyamatbeállítások felhasználói felületén.

A sekély beolvasás letiltásához hajtsa végre az alábbi két lehetőség egyikét.

Egy folyamat beolvasási mélységének konfigurálásához beállíthatja a fetchDepth tulajdonságot a checkout lépésben, vagy konfigurálhatja a Sekély beolvasás beállítást a folyamatbeállítások felhasználói felületén.

Megjegyzés

Ha explicit módon állítja be fetchDepth a checkout lépést, akkor ez a beállítás elsőbbséget élvez a folyamatbeállítások felhasználói felületén konfigurált beállítással szemben. A beállítás fetchDepth: 0 lekéri az összes előzményt, és felülbírálja a Sekély beolvasás beállítást.

Clean tulajdonság

Ha a clean tulajdonság nincs megadva, akkor az alapértelmezett értékét a YAML-folyamatok felhasználói felületi beállításaiban található tiszta beállítás konfigurálja, amely alapértelmezés szerint igaz értékre van állítva. A használatával checkoutelérhető tisztítási lehetőség mellett a munkaterületen is konfigurálhatja a tisztítást. A munkaterületekkel és a tiszta beállításokkal kapcsolatos további információkért tekintse meg a Munkaterületek témakört a Feladatok területen.

Címkék szinkronizálása

A kivételi lépés ezt a --tags lehetőséget használja egy Git-adattár tartalmának beolvasásakor. Ez azt eredményezi, hogy a kiszolgáló beolvassa az összes címkét, valamint az összes olyan objektumot, amelyekre ezek a címkék mutatnak. Ez növeli a feladat folyamaton belüli futtatásának idejét, különösen akkor, ha több címkével rendelkező nagy adattárral rendelkezik. Emellett a kivételi lépés akkor is szinkronizálja a címkéket, ha engedélyezi a sekély beolvasási lehetőséget, így esetleg nem tudja a célját. A Git-adattárból lekért vagy lekért adatok mennyiségének csökkentése érdekében a Microsoft új kivételi lehetőséget adott a címkék szinkronizálásának szabályozására. Ez a lehetőség klasszikus és YAML-folyamatokban is elérhető.

Azt, hogy szinkronizálja-e a címkéket egy adattár kivételekor, konfigurálható-e a YAML-ben a fetchTags tulajdonság beállításával, illetve a felhasználói felületen a Címkék szinkronizálása beállítás konfigurálásával.

A BEÁLLÍTÁS YAML-ben való konfigurálásához állítsa be a tulajdonságot fetchTags .

steps:
- checkout: self
  fetchTags: true

A folyamat felhasználói felületén a beállítás konfigurálásához szerkessze a YAML-folyamatot, és válassza a További műveletek, az Eseményindítók, a YAML, a Források lekérése lehetőséget, majd jelölje be a Címkék szinkronizálása jelölőnégyzetet, vagy törölje belőle a jelet. További információ: Címkék szinkronizálása.

Alapértelmezett viselkedés

  • A 2022 szeptemberében kiadott Azure DevOps Sprint 209 kiadása előtt létrehozott meglévő folyamatok esetében a címkék szinkronizálásának alapértelmezett beállítása ugyanaz marad, mint a meglévő működés a Címkék szinkronizálása beállítás hozzáadása előtt, ami a következő true: .
  • Az Azure DevOps sprint 209-es kiadása után létrehozott új folyamatok esetében a címkék szinkronizálásának alapértelmezett értéke .false

Fontos

A felhasználói felületen a True (Igaz) szinkronizálási címkék beállítása elsőbbséget élvez a fetchTags: false YAML-ben szereplő utasítással szemben. Ha a szinkronizálási címkék true (igaz) értékre vannak állítva a felhasználói felületen, a címkék akkor is szinkronizálódnak, ha fetchTags a YAML-ben false (hamis) értékre van állítva.

Példák

A források szinkronizálásának elkerülése érdekében:

steps:
- checkout: none

Megjegyzés

Ha az ügynököt a helyi szolgáltatásfiókban futtatja, és git-műveletekkel vagy Git-almodulok betöltésével módosítani szeretné az aktuális adattárat, adja meg a megfelelő engedélyeket a Projektgyűjtemény buildelési szolgáltatásfiókjainak felhasználójának.

- checkout: self
  submodules: true
  persistCredentials: true

Ha több adattárat szeretne kivenni a folyamatból, kövesse az alábbi lépéseket checkout :

- checkout: self
- checkout: git://MyProject/MyRepo
- checkout: MyGitHubRepo # Repo declared in a repository resource

További információ: Több adattár megtekintése a folyamatban.

Lásd még