Azure DevOps · Schema

BuildRepository

Repository configuration for a build

AgileCI/CDDevOpsProject ManagementVersion Control

Properties

Name	Type	Description
id	string	Repository ID (GUID for Git, name for TFVC)
name	string	Repository name
type	string	Repository type
url	string	URL of the repository
defaultBranch	string	Default branch for this repository
checkoutSubmodules	boolean	Whether to checkout Git submodules
clean	string	Whether to clean the working directory before each build
properties	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BuildRepository",
  "title": "BuildRepository",
  "type": "object",
  "description": "Repository configuration for a build",
  "properties": {
    "id": {
      "type": "string",
      "description": "Repository ID (GUID for Git, name for TFVC)"
    },
    "name": {
      "type": "string",
      "description": "Repository name"
    },
    "type": {
      "type": "string",
      "description": "Repository type",
      "enum": [
        "TfsGit",
        "TfsVersionControl",
        "GitHub",
        "Bitbucket",
        "GitHubEnterprise"
      ]
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL of the repository"
    },
    "defaultBranch": {
      "type": "string",
      "description": "Default branch for this repository",
      "example": "refs/heads/main"
    },
    "checkoutSubmodules": {
      "type": "boolean",
      "description": "Whether to checkout Git submodules"
    },
    "clean": {
      "type": "string",
      "description": "Whether to clean the working directory before each build",
      "enum": [
        "true",
        "false",
        null
      ]
    },
    "properties": {
      "type": "object",
      "additionalProperties": true
    }
  }
}