azldev.schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/microsoft/azure-linux-dev-tools/internal/projectconfig/config-file",
  "$ref": "#/$defs/ConfigFile",
  "$defs": {
    "CheckConfig": {
      "properties": {
        "skip": {
          "type": "boolean",
          "title": "Skip check",
          "description": "Disables the %check section by prepending 'exit 0' when set to true"
        },
        "skip_reason": {
          "type": "string",
          "title": "Skip reason",
          "description": "Required justification for skipping the %check section"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ComponentBuildConfig": {
      "properties": {
        "with": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "With options",
          "description": "'with' options to pass to the builder."
        },
        "without": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Without options",
          "description": "'without' options to pass to the builder."
        },
        "defines": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object",
          "title": "Macro definitions",
          "description": "Macro definitions to pass to the builder."
        },
        "undefines": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Undefined macros",
          "description": "Macro names to undefine when passing to the builder."
        },
        "check": {
          "$ref": "#/$defs/CheckConfig",
          "title": "Check configuration",
          "description": "Configuration for the %check section"
        },
        "failure": {
          "$ref": "#/$defs/ComponentBuildFailureConfig",
          "title": "Build failure configuration",
          "description": "Configuration and policy regarding build failures for this component."
        },
        "hints": {
          "$ref": "#/$defs/ComponentBuildHints",
          "title": "Build hints",
          "description": "Non-essential hints for how or when to build the component."
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ComponentBuildFailureConfig": {
      "properties": {
        "expected": {
          "type": "boolean",
          "title": "Expected failure",
          "description": "Indicates that this component is expected to fail building."
        },
        "expected-reason": {
          "type": "string",
          "title": "Expected failure reason",
          "description": "Required justification for why this component is expected to fail building."
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ComponentBuildHints": {
      "properties": {
        "expensive": {
          "type": "boolean",
          "title": "Expensive to build",
          "description": "Indicates that building this component is expensive and should be carefully considered when scheduling."
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ComponentConfig": {
      "properties": {
        "spec": {
          "$ref": "#/$defs/SpecSource",
          "title": "Spec",
          "description": "Identifies where to find the spec for this component"
        },
        "overlays": {
          "items": {
            "$ref": "#/$defs/ComponentOverlay"
          },
          "type": "array",
          "title": "Overlays",
          "description": "Overlays to apply to this component's spec and/or sources"
        },
        "build": {
          "$ref": "#/$defs/ComponentBuildConfig",
          "title": "Build configuration",
          "description": "Configuration for building the component"
        },
        "source-files": {
          "items": {
            "$ref": "#/$defs/SourceFileReference"
          },
          "type": "array",
          "title": "Source files",
          "description": "Source files to download for this component"
        },
        "default-package-config": {
          "$ref": "#/$defs/PackageConfig",
          "title": "Default package config",
          "description": "Default configuration applied to all binary packages produced by this component"
        },
        "packages": {
          "additionalProperties": {
            "$ref": "#/$defs/PackageConfig"
          },
          "type": "object",
          "title": "Package overrides",
          "description": "Per-package configuration overrides keyed by exact binary package name"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ComponentGroupConfig": {
      "properties": {
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Description of this component group"
        },
        "components": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Components",
          "description": "List of component names that are members of this group"
        },
        "specs": {
          "items": {
            "type": "string",
            "examples": [
              "SPECS/**/.spec"
            ]
          },
          "type": "array",
          "title": "Spec path patterns",
          "description": "List of glob patterns identifying local specs for components in this group"
        },
        "excluded-paths": {
          "items": {
            "type": "string",
            "examples": [
              "build/**"
            ]
          },
          "type": "array",
          "title": "Excluded path patterns",
          "description": "List of glob patterns identifying local paths to exclude from spec selection"
        },
        "default-component-config": {
          "$ref": "#/$defs/ComponentConfig",
          "title": "Default component configuration",
          "description": "Default component config inherited by all members of this component group"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ComponentOverlay": {
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "spec-add-tag",
            "spec-insert-tag",
            "spec-set-tag",
            "spec-update-tag",
            "spec-remove-tag",
            "spec-prepend-lines",
            "spec-append-lines",
            "spec-search-replace",
            "spec-remove-section",
            "patch-add",
            "patch-remove",
            "file-prepend-lines",
            "file-search-replace",
            "file-add",
            "file-remove",
            "file-rename"
          ],
          "title": "Overlay type",
          "description": "The type of overlay to apply"
        },
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Human readable description of overlay"
        },
        "file": {
          "type": "string",
          "title": "Filename",
          "description": "The name of the non-spec file to which this overlay applies"
        },
        "section": {
          "type": "string",
          "title": "Section name",
          "description": "The name of the section to which this overlay applies"
        },
        "package": {
          "type": "string",
          "title": "Package name",
          "description": "The name of the sub-package to which this overlay applies"
        },
        "tag": {
          "type": "string",
          "title": "Tag",
          "description": "For overlays that apply to spec tags"
        },
        "value": {
          "type": "string",
          "title": "Value",
          "description": "An exact string value to match in the spec"
        },
        "regex": {
          "type": "string",
          "title": "Regular expression",
          "description": "The regular expression to match in the spec"
        },
        "replacement": {
          "type": "string",
          "title": "Replacement text",
          "description": "The replacement text to use in the spec"
        },
        "lines": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Lines",
          "description": "The lines of text to use"
        },
        "source": {
          "type": "string",
          "title": "Source",
          "description": "For overlays that require a source file as input"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type"
      ]
    },
    "ConfigFile": {
      "properties": {
        "$schema": {
          "type": "string"
        },
        "project": {
          "$ref": "#/$defs/ProjectInfo",
          "title": "Project info",
          "description": "Basic properties for this project"
        },
        "includes": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Includes",
          "description": "List of glob patterns specifying additional config files to load"
        },
        "distros": {
          "additionalProperties": {
            "$ref": "#/$defs/DistroDefinition"
          },
          "type": "object",
          "title": "Distros",
          "description": "Definitions of distros to build for or consume from"
        },
        "component-groups": {
          "additionalProperties": {
            "$ref": "#/$defs/ComponentGroupConfig"
          },
          "type": "object",
          "title": "Component groups",
          "description": "Definitions of component groups for this project"
        },
        "components": {
          "additionalProperties": {
            "$ref": "#/$defs/ComponentConfig"
          },
          "type": "object",
          "title": "Components",
          "description": "Definitions of components for this project"
        },
        "images": {
          "additionalProperties": {
            "$ref": "#/$defs/ImageConfig"
          },
          "type": "object",
          "title": "Images",
          "description": "Definitions of images for this project"
        },
        "tools": {
          "$ref": "#/$defs/ToolsConfig",
          "title": "Tools configuration",
          "description": "Configuration for tools used by azldev"
        },
        "default-package-config": {
          "$ref": "#/$defs/PackageConfig",
          "title": "Default package config",
          "description": "Project-wide default applied to all binary packages before group and component overrides"
        },
        "package-groups": {
          "additionalProperties": {
            "$ref": "#/$defs/PackageGroupConfig"
          },
          "type": "object",
          "title": "Package groups",
          "description": "Definitions of package groups for shared binary package configuration"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "DistroDefinition": {
      "properties": {
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Human readable description"
        },
        "default-version": {
          "type": "string",
          "title": "Default version",
          "description": "Default version for this distro"
        },
        "dist-git-base-uri": {
          "type": "string",
          "format": "uri",
          "title": "Dist-git base URI",
          "description": "Base URI for the dist-git repository for this distro"
        },
        "lookaside-base-uri": {
          "type": "string",
          "format": "uri",
          "title": "Lookaside base URI",
          "description": "Base URI for lookaside cache for this distro"
        },
        "repos": {
          "items": {
            "$ref": "#/$defs/PackageRepository"
          },
          "type": "array",
          "title": "Package Repositories",
          "description": "List of package repository definitions"
        },
        "disable-origins": {
          "type": "boolean",
          "title": "Disable origins",
          "description": "When true only allow source files from the lookaside cache and do not fall back to configured origins"
        },
        "versions": {
          "additionalProperties": {
            "$ref": "#/$defs/DistroVersionDefinition"
          },
          "type": "object",
          "title": "Versions",
          "description": "Mapping of distro version definitions"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "DistroReference": {
      "properties": {
        "name": {
          "type": "string",
          "title": "Name",
          "description": "Name of the referenced distro"
        },
        "version": {
          "type": "string",
          "title": "Version",
          "description": "Version of the referenced distro"
        },
        "snapshot": {
          "type": "string",
          "format": "date-time",
          "title": "Snapshot",
          "description": "If specified use source code as it existed at this date/time"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "name"
      ]
    },
    "DistroVersionDefinition": {
      "properties": {
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Human readable description of the distro version"
        },
        "release-ver": {
          "type": "string",
          "title": "Release version",
          "description": "Formal releasever string"
        },
        "dist-git-branch": {
          "type": "string",
          "title": "Dist-git branch",
          "description": "Branch in the dist-git repository for this version"
        },
        "default-component-config": {
          "$ref": "#/$defs/ComponentConfig",
          "title": "Default component config",
          "description": "Default component config inherited by all components built for this distro"
        },
        "mock-config": {
          "type": "string",
          "title": "Mock config file",
          "description": "Path to the mock config file for this version"
        },
        "mock-config-x86_64": {
          "type": "string",
          "title": "Mock config file",
          "description": "Path to the x86_64 mock config file for this version"
        },
        "mock-config-aarch64": {
          "type": "string",
          "title": "Mock config file",
          "description": "Path to the aarch64 mock config file for this version"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "release-ver"
      ]
    },
    "ImageConfig": {
      "properties": {
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Description of the image"
        },
        "definition": {
          "$ref": "#/$defs/ImageDefinition",
          "title": "Definition",
          "description": "Identifies where to find the definition for this image"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ImageCustomizerConfig": {
      "properties": {
        "containerTag": {
          "type": "string",
          "title": "Container tag",
          "description": "Container tag of the Image Customizer container"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "ImageDefinition": {
      "properties": {
        "type": {
          "type": "string",
          "title": "Type",
          "description": "Type of image definition"
        },
        "path": {
          "type": "string",
          "title": "Path",
          "description": "Path to the image definition file"
        },
        "profile": {
          "type": "string",
          "title": "Profile",
          "description": "Optional field that specifies the profile to use when building the image"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "Origin": {
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "download"
          ],
          "title": "Origin type",
          "description": "Type of origin for this source file"
        },
        "uri": {
          "type": "string",
          "title": "URI",
          "description": "URI to download the source file from if origin type is 'download'",
          "examples": [
            "https://example.com/source.tar.gz"
          ]
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type"
      ]
    },
    "PackageConfig": {
      "properties": {
        "publish": {
          "$ref": "#/$defs/PackagePublishConfig",
          "title": "Publish settings",
          "description": "Publishing settings for this binary package"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "PackageGroupConfig": {
      "properties": {
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Human-readable description of this package group"
        },
        "packages": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Packages",
          "description": "Explicit list of binary package names that are members of this group"
        },
        "default-package-config": {
          "$ref": "#/$defs/PackageConfig",
          "title": "Default package config",
          "description": "Configuration inherited by all packages in this group"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "PackagePublishConfig": {
      "properties": {
        "channel": {
          "type": "string",
          "title": "Channel",
          "description": "Publish channel for this package; use 'none' to signal to downstream tooling that this package should not be published"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "PackageRepository": {
      "properties": {
        "base-uri": {
          "type": "string",
          "title": "Base URI",
          "description": "Base URI for the repository"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "base-uri"
      ]
    },
    "ProjectInfo": {
      "properties": {
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Human readable project description"
        },
        "log-dir": {
          "type": "string",
          "title": "Log Directory",
          "description": "Path to the log directory",
          "examples": [
            "logs"
          ]
        },
        "work-dir": {
          "type": "string",
          "title": "Work Directory",
          "description": "Path to temporary working directory",
          "examples": [
            "work"
          ]
        },
        "output-dir": {
          "type": "string",
          "title": "Output Directory",
          "description": "Path to the output directory",
          "examples": [
            "out"
          ]
        },
        "rendered-specs-dir": {
          "type": "string",
          "title": "Rendered Specs Directory",
          "description": "Output directory for rendered specs",
          "examples": [
            "SPECS"
          ]
        },
        "default-distro": {
          "$ref": "#/$defs/DistroReference",
          "title": "Default Distro",
          "description": "Default selected distro reference"
        },
        "default-author-email": {
          "type": "string",
          "title": "Default Author Email",
          "description": "Default email for synthetic changelog entries and commits"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "SourceFileReference": {
      "properties": {
        "filename": {
          "type": "string"
        },
        "hash": {
          "type": "string"
        },
        "hash-type": {
          "type": "string",
          "enum": [
            "SHA256",
            "SHA512"
          ],
          "title": "Hash type",
          "description": "Hash algorithm used for the hash value"
        },
        "origin": {
          "$ref": "#/$defs/Origin"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "filename"
      ]
    },
    "SpecSource": {
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "local",
            "upstream",
            ""
          ],
          "title": "Source Type",
          "description": "The type of the spec source"
        },
        "path": {
          "type": "string",
          "title": "Path",
          "description": "Path to the spec (if available locally)",
          "examples": [
            "specs/mycomponent.spec"
          ]
        },
        "upstream-distro": {
          "$ref": "#/$defs/DistroReference",
          "title": "Upstream distro",
          "description": "Reference to the upstream distro providing the spec"
        },
        "upstream-name": {
          "type": "string",
          "title": "Upstream component name",
          "description": "Name of the component in the upstream distro",
          "examples": [
            "different-name"
          ]
        },
        "upstream-commit": {
          "type": "string",
          "maxLength": 40,
          "minLength": 7,
          "pattern": "^[0-9a-fA-F]+$",
          "title": "Upstream commit",
          "description": "Git commit hash to pin the upstream spec to. Takes priority over snapshot.",
          "examples": [
            "abc1234def5678"
          ]
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type"
      ]
    },
    "ToolsConfig": {
      "properties": {
        "imageCustomizer": {
          "$ref": "#/$defs/ImageCustomizerConfig",
          "title": "Image Customizer tool configuration",
          "description": "Configuration for the Image Customizer tool"
        }
      },
      "additionalProperties": false,
      "type": "object"
    }
  },
  "$comment": "This schema was auto-generated by: azldev config generate-schema"
}