Shallow fetch for repository

Question

I have an Azure Pipeline (yaml) which uses templates and I'm trying to figure out how to setup the fetch depth of the actual repository being cloned.

resources:
  repositories:
    - repository: templates
      type: git
      name: 'DevOps/CICD'
      ref: refs/heads/develop
    - repository: self # sic!
      fetchDepth: 1
      clean: true`

Fetch depth is supported (vscode extension) but I can't seem to find any extensive documentation on it..

Just a comment for in case it's been missed so far, when you use templates it doesn't do a checkout of repo you reference, it just references those yaml files. The accepted answer mentions doing an actual checkout which would give you access to the other non yaml files from where you are referencing the template but are 2 different things — Gordon Beeming, Jan 06 '22 at 07:52

score 26 · Accepted Answer · answered Jan 17 '19 at 09:25

26

Placing this under steps works for me:

steps:
  - checkout: self
    fetchDepth: 1
    clean: true
  - task: NuGetCommand@2
  ...

Results in:

2019-01-17T09:21:45.1133753Z ##[command]git -c http.extraheader="AUTHORIZATION: bearer ***" fetch --tags --prune --progress --no-recurse-submodules --depth=1 origin

answered Jan 17 '19 at 09:25

grmbl

2,514
4
29
54

1

https://developercommunity.visualstudio.com/content/problem/294872/yaml-build-ignores-fetchdepth.html – mloskot Jan 20 '19 at 17:49
1

NOTE: If you are using tags you may still be downloading more than you expect. You can disable tags by using "fetchTags: false" alongside "fetchDepth: 1" as seen in the above. I had the above step and could see "--depth=1" in my pipeline output, but it was still downloading too much, disabling tags fixed it for me! – Peter Rasmussen May 16 '23 at 14:06

Craig Brown · Answer 2 · 2023-07-15T13:18:49.863

Another option is to add the shallow fetch setting into the Variables section of your YAML pipeline:

variables:
  Agent.Source.Git.ShallowFetchDepth: 1

Azure Pipelines will automatically recognize this setting and use it as a --depth=1 argument when it does git fetch.

Note that this only applies to pipelines created before September 2022 – pipelines created after that date will automatically fetch with a depth of 1, so it doesn't need to be explicitly configured.

4c74356b41 · Answer 3 · 2019-01-17T09:36:09.897

5

here's the link you are looking for: https://learn.microsoft.com/en-us/azure/devops/pipelines/yaml-schema?view=vsts&tabs=schema#checkout

the property is fetchDepth indeed.

edited Jan 17 '19 at 09:36

answered Jan 17 '19 at 08:49

4c74356b41

69,186
6
100
141

thanks! any idea where this should be set? (in yaml hierarchy) – grmbl Jan 17 '19 at 08:59
pretty sure thats the root of the hierarchy, so at the first level – 4c74356b41 Jan 17 '19 at 09:01
nvm, found it, under `steps` – grmbl Jan 17 '19 at 09:01
not sure why it would be understeps, maybe if you need to checkout something directly in the phase – 4c74356b41 Jan 17 '19 at 09:03
it doesnt have to be repository, it can be just repo (works for me across many builds) – 4c74356b41 Jan 17 '19 at 09:08
just tested this under resources/repositories, no effect... trying under steps now – grmbl Jan 17 '19 at 09:18
Confirm this works when under `steps`... `2019-01-17T09:21:45.1133753Z ##[command]git -c http.extraheader="AUTHORIZATION: bearer ***" fetch --tags --prune --progress --no-recurse-submodules --depth=1 origin` – grmbl Jan 17 '19 at 09:22
It's set at the step level as not every job requires the same or any source code - for example non-deployment jobs don't checkout code by default, other steps may want to build a different repo. – Zhaph - Ben Duguid Jun 02 '20 at 13:37
links change and break, your answer is no longer relevant. – Urasquirrel Dec 02 '22 at 19:55

Shallow fetch for repository

3 Answers3

Linked