Skip to content

[BUG]: Default fetchDepth can break 'git describe' #5514

@smacdonald-kai

Description

@smacdonald-kai

What happened?

(This response said checkout task is handled here, not there: microsoft/azure-pipelines-tasks#14490 (comment) )

My build creates a version number using 'git describe'. The default fetchDepth is 1. The branch I'm building has a very long history.

In this specific instance, the task did not check out enough of the git graph to have the pipeline's build generate the correct, same-as-on-my-local-build, version number.

I understand why the default is what it is. I am asking for the checkout task documentation for fetchDepth to include a warning about potential interference with 'git describe'. ( https://learn.microsoft.com/en-us/azure/devops/pipelines/yaml-schema/steps-checkout?view=azure-pipelines )

I'm hoping to make this corner case easier to future developers to understand and/or avoid.

Versions

No idea how to find this info. Pipeline is using 'vmImage: windows-2022'

Environment type (Please select at least one enviroment where you face this issue)

  • Self-Hosted
  • Microsoft Hosted
  • VMSS Pool
  • Container

Azure DevOps Server type

dev.azure.com (formerly visualstudio.com)

Azure DevOps Server Version (if applicable)

No response

Operation system

No response

Version controll system

git

Relevant log output

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions