schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {
    "Buildpack": {
      "properties": {
        "type": {
          "type": "string",
          "const": "buildpack",
          "description": "buildpack generates a container image using Cloud Native Buildpacks and\npublishes it to the Halfpipe registry. The task uses [Paketo Buildpacks]\nwhich is an implementation of the Cloud Native Buildpacks specification.\n\n[Paketo Buildpacks]: https://paketo.io"
        },
        "name": {
          "type": "string",
          "description": "Optional display name."
        },
        "image": {
          "type": "string",
          "description": "Docker image name to build and push. Format: eu.gcr.io/halfpipe-io/\u003cteam\u003e/\u003cimage-name\u003e."
        },
        "buildpacks": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Buildpack identifiers to use for building the image e.g. paketo-buildpacks/java."
        },
        "builder": {
          "type": "string",
          "description": "Paketo builder to use. Defaults to paketobuildpacks/builder-jammy-buildpackless-base."
        },
        "path": {
          "type": "string",
          "description": "Path to the application source code to build. Defaults to current directory."
        },
        "restore_artifacts": {
          "type": "boolean",
          "description": "Restore artifacts saved by previous tasks."
        },
        "vars": {
          "$ref": "#/$defs/Vars",
          "description": "Environment variables passed to the pack build command."
        },
        "manual_trigger": {
          "type": "boolean",
          "description": "Task must be triggered manually (Concourse only)."
        },
        "retries": {
          "type": "integer",
          "description": "Number of times to retry the task if it fails."
        },
        "notify_on_success": {
          "type": "boolean",
          "description": "Deprecated: use notifications instead.",
          "deprecated": true,
          "deprecationMessage": "use notifications instead"
        },
        "notifications": {
          "$ref": "#/$defs/Notifications",
          "description": "Notification channels for this task."
        },
        "timeout": {
          "type": "string",
          "description": "Timeout duration for the task. If exceeded the task fails. Defaults to 1h."
        },
        "build_history": {
          "type": "integer",
          "description": "Number of build logs to retain. Defaults to 20 (Concourse only)."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type",
        "image",
        "buildpacks"
      ],
      "description": "buildpack generates a container image using Cloud Native Buildpacks and\npublishes it to the Halfpipe registry. The task uses [Paketo Buildpacks]\nwhich is an implementation of the Cloud Native Buildpacks specification.\n\n[Paketo Buildpacks]: https://paketo.io"
    },
    "ComposeFiles": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "ConsumerIntegrationTest": {
      "properties": {
        "type": {
          "type": "string",
          "const": "consumer-integration-test",
          "description": "consumer-integration-test is designed to run in a provider's pipeline. The\ntask allows for a test script to be run. The script is passed two environment\nvariables automatically: DEPENDENCY_NAME (set by provider_name) and\n\u003cDEPENDENCY_NAME\u003e_DEPLOYED_HOST (set by provider_host)."
        },
        "name": {
          "type": "string",
          "description": "Optional display name."
        },
        "consumer": {
          "type": "string",
          "description": "GitHub repository name of the consumer, with optional sub-directory for monorepos e.g. repo-name or monorepo/dir."
        },
        "consumer_host": {
          "type": "string",
          "description": "Address of the consumer application in the same environment as the provider."
        },
        "script": {
          "type": "string",
          "description": "Consumer test script to execute."
        },
        "git_clone_options": {
          "type": "string",
          "description": "Custom options for git clone of the consumer repository e.g. --depth 100."
        },
        "provider_host": {
          "type": "string",
          "description": "Address of the provider application to test. Defaults to the candidate route in pre_promote."
        },
        "provider_name": {
          "type": "string",
          "description": "Name of the provider app, exposed as DEPENDENCY_NAME. Defaults to the pipeline name."
        },
        "docker_compose_file": {
          "type": "string",
          "description": "Path to the consumer docker-compose file. Defaults to docker-compose.yml."
        },
        "docker_compose_service": {
          "type": "string",
          "description": "Service name in the consumer docker-compose. Defaults to code."
        },
        "vars": {
          "$ref": "#/$defs/Vars",
          "description": "Environment variables available to the docker-compose service."
        },
        "use_covenant": {
          "type": "boolean",
          "description": "Enable Covenant contract testing support."
        },
        "save_artifacts": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Paths to files or directories to save for use in subsequent tasks."
        },
        "save_artifacts_on_failure": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Paths to save when the task fails, useful for test reports."
        },
        "manual_trigger": {
          "type": "boolean",
          "description": "Task must be triggered manually (Concourse only)."
        },
        "retries": {
          "type": "integer",
          "description": "Number of times to retry the task if it fails."
        },
        "notify_on_success": {
          "type": "boolean",
          "description": "Deprecated: use notifications instead.",
          "deprecated": true,
          "deprecationMessage": "use notifications instead"
        },
        "notifications": {
          "$ref": "#/$defs/Notifications",
          "description": "Notification channels for this task."
        },
        "timeout": {
          "type": "string",
          "description": "Timeout duration for the task. If exceeded the task fails. Defaults to 1h."
        },
        "build_history": {
          "type": "integer",
          "description": "Number of build logs to retain. Defaults to 20 (Concourse only)."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type",
        "consumer",
        "consumer_host",
        "script"
      ],
      "description": "consumer-integration-test is designed to run in a provider's pipeline. The\ntask allows for a test script to be run. The script is passed two environment\nvariables automatically: DEPENDENCY_NAME (set by provider_name) and\n\u003cDEPENDENCY_NAME\u003e_DEPLOYED_HOST (set by provider_host)."
    },
    "CopyContainerImage": {
      "properties": {
        "type": {
          "type": "string",
          "const": "copy-container-image",
          "description": "copy-container-image copies an image from the halfpipe registry\n(eu.gcr.io/halfpipe-io/) to another registry. Currently only AWS ECR is\nsupported as the target. Normally this would be used after a docker-push\nor buildpack task."
        },
        "name": {
          "type": "string",
          "description": "Optional display name."
        },
        "source": {
          "type": "string",
          "description": "Full source image URL in the halfpipe registry, with or without tag."
        },
        "target": {
          "type": "string",
          "description": "Target ECR image URL or bare ECR registry URL."
        },
        "aws_access_key_id": {
          "type": "string",
          "description": "AWS access key ID for the target ECR registry. Defaults to shared credentials from Vault."
        },
        "aws_secret_access_key": {
          "type": "string",
          "description": "AWS secret access key for the target ECR registry. Defaults to shared credentials from Vault."
        },
        "manual_trigger": {
          "type": "boolean",
          "description": "Task must be triggered manually (Concourse only)."
        },
        "retries": {
          "type": "integer",
          "description": "Number of times to retry the task if it fails."
        },
        "notify_on_success": {
          "type": "boolean",
          "description": "Deprecated: use notifications instead.",
          "deprecated": true,
          "deprecationMessage": "use notifications instead"
        },
        "notifications": {
          "$ref": "#/$defs/Notifications",
          "description": "Notification channels for this task."
        },
        "timeout": {
          "type": "string",
          "description": "Timeout duration for the task. If exceeded the task fails. Defaults to 1h."
        },
        "build_history": {
          "type": "integer",
          "description": "Number of build logs to retain. Defaults to 20 (Concourse only)."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type",
        "source",
        "target"
      ],
      "description": "copy-container-image copies an image from the halfpipe registry\n(eu.gcr.io/halfpipe-io/) to another registry. Currently only AWS ECR is\nsupported as the target. Normally this would be used after a docker-push\nor buildpack task."
    },
    "DeployCF": {
      "properties": {
        "type": {
          "type": "string",
          "const": "deploy-cf",
          "description": "deploy-cf deploys an app to Cloud Foundry."
        },
        "name": {
          "type": "string",
          "description": "Optional display name."
        },
        "space": {
          "type": "string",
          "description": "Cloud Foundry space to deploy to."
        },
        "api": {
          "type": "string",
          "description": "Cloud Foundry API endpoint. Defaults to ((cloudfoundry.api-snpaas))."
        },
        "org": {
          "type": "string",
          "description": "Cloud Foundry organisation. Defaults to the value of team."
        },
        "username": {
          "type": "string",
          "description": "Cloud Foundry username. Defaults to ((cloudfoundry.username))."
        },
        "password": {
          "type": "string",
          "description": "Cloud Foundry password. Defaults to ((cloudfoundry.password))."
        },
        "manifest": {
          "type": "string",
          "description": "Path to the Cloud Foundry app manifest, relative to the halfpipe manifest. Defaults to manifest.yml."
        },
        "test_domain": {
          "type": "string",
          "description": "Domain used when pushing the app as a candidate. Derived from the API by default."
        },
        "vars": {
          "$ref": "#/$defs/Vars",
          "description": "Environment variables injected into the CF app environment."
        },
        "deploy_artifact": {
          "type": "string",
          "description": "Path to a file or directory saved by a previous task to deploy to CF."
        },
        "pre_promote": {
          "items": {
            "oneOf": [
              {
                "$ref": "#/$defs/Run"
              },
              {
                "$ref": "#/$defs/DeployCF"
              },
              {
                "$ref": "#/$defs/DeployKatee"
              },
              {
                "$ref": "#/$defs/DockerPush"
              },
              {
                "$ref": "#/$defs/DockerCompose"
              },
              {
                "$ref": "#/$defs/ConsumerIntegrationTest"
              },
              {
                "$ref": "#/$defs/DeployMLZip"
              },
              {
                "$ref": "#/$defs/DeployMLModules"
              },
              {
                "$ref": "#/$defs/Parallel"
              },
              {
                "$ref": "#/$defs/Sequence"
              },
              {
                "$ref": "#/$defs/Buildpack"
              },
              {
                "$ref": "#/$defs/CopyContainerImage"
              }
            ]
          },
          "type": "array",
          "description": "Tasks to run after the candidate is deployed but before it is promoted to live. TEST_ROUTE is injected."
        },
        "pre_start": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "CF CLI commands to run immediately before the candidate app is started."
        },
        "rolling": {
          "type": "boolean",
          "description": "Use rolling deployment instead of blue-green."
        },
        "stop_candidate_on_failure": {
          "type": "boolean",
          "description": "Stop the candidate app if deployment fails."
        },
        "cli_version": {
          "type": "string",
          "description": "CF CLI version to use. Allowed values: cf7, cf8. Defaults to cf7."
        },
        "docker_tag": {
          "type": "string",
          "description": "Docker image tag to deploy. Required when deploying a Docker image: version or gitref."
        },
        "sso_route": {
          "type": "string",
          "description": "Route to configure with SSO."
        },
        "github_environment": {
          "$ref": "#/$defs/GitHubEnvironment",
          "description": "GitHub environment to associate with this deployment."
        },
        "manual_trigger": {
          "type": "boolean",
          "description": "Task must be triggered manually (Concourse only)."
        },
        "retries": {
          "type": "integer",
          "description": "Number of times to retry the task if it fails."
        },
        "notify_on_success": {
          "type": "boolean",
          "description": "Deprecated: use notifications instead.",
          "deprecated": true,
          "deprecationMessage": "use notifications instead"
        },
        "notifications": {
          "$ref": "#/$defs/Notifications",
          "description": "Notification channels for this task."
        },
        "timeout": {
          "type": "string",
          "description": "Timeout duration for the task. If exceeded the task fails. Defaults to 1h."
        },
        "build_history": {
          "type": "integer",
          "description": "Number of build logs to retain. Defaults to 20 (Concourse only)."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type",
        "space"
      ],
      "description": "deploy-cf deploys an app to Cloud Foundry."
    },
    "DeployKatee": {
      "properties": {
        "type": {
          "type": "string",
          "const": "deploy-katee",
          "description": "deploy-katee deploys an application to Katee."
        },
        "name": {
          "type": "string",
          "description": "Optional display name."
        },
        "vars": {
          "$ref": "#/$defs/Vars",
          "description": "Environment variables available to the vela manifest."
        },
        "vela_manifest": {
          "type": "string",
          "description": "Path to the vela manifest. Defaults to vela.yaml."
        },
        "tag": {
          "type": "string",
          "description": "Deprecated: no longer used - safe to delete.",
          "deprecated": true,
          "deprecationMessage": "no longer used - safe to delete"
        },
        "environment": {
          "type": "string",
          "description": "Deprecated: no longer used - safe to delete.",
          "deprecated": true,
          "deprecationMessage": "no longer used - safe to delete"
        },
        "namespace": {
          "type": "string",
          "description": "Vela namespace to deploy to. Defaults to katee-\u003cteam\u003e."
        },
        "deployment_check_timeout": {
          "type": "integer",
          "description": "Deprecated: use max_checks and check_interval instead.",
          "deprecated": true,
          "deprecationMessage": "use max_checks and check_interval instead"
        },
        "check_interval": {
          "type": "integer",
          "description": "Seconds between each deployment status check. Defaults to 2."
        },
        "max_checks": {
          "type": "integer",
          "description": "Maximum number of status checks before the deployment is considered failed. Defaults to 60."
        },
        "github_environment": {
          "$ref": "#/$defs/GitHubEnvironment",
          "description": "GitHub environment to associate with this deployment."
        },
        "manual_trigger": {
          "type": "boolean",
          "description": "Task must be triggered manually (Concourse only)."
        },
        "retries": {
          "type": "integer",
          "description": "Number of times to retry the task if it fails."
        },
        "notify_on_success": {
          "type": "boolean",
          "description": "Deprecated: use notifications instead.",
          "deprecated": true,
          "deprecationMessage": "use notifications instead"
        },
        "notifications": {
          "$ref": "#/$defs/Notifications",
          "description": "Notification channels for this task."
        },
        "timeout": {
          "type": "string",
          "description": "Timeout duration for the task. If exceeded the task fails. Defaults to 1h."
        },
        "build_history": {
          "type": "integer",
          "description": "Number of build logs to retain. Defaults to 20 (Concourse only)."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type"
      ],
      "description": "deploy-katee deploys an application to Katee."
    },
    "DeployMLModules": {
      "properties": {
        "type": {
          "type": "string",
          "const": "deploy-ml-modules",
          "description": "deploy-ml-modules deploys a version of the shared ml modules library from\nartifactory."
        },
        "name": {
          "type": "string",
          "description": "Optional display name."
        },
        "ml_modules_version": {
          "type": "string",
          "description": "Version of the ml-modules artifact in Artifactory."
        },
        "targets": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "MarkLogic instances to deploy to."
        },
        "app_name": {
          "type": "string",
          "description": "App name in MarkLogic. Defaults to the pipeline name."
        },
        "app_version": {
          "type": "string",
          "description": "App version in MarkLogic. Defaults to the git revision. Cannot be set with use_build_version."
        },
        "use_build_version": {
          "type": "boolean",
          "description": "Use $BUILD_VERSION instead of $GIT_REVISION for the app version. Cannot be set with app_version."
        },
        "username": {
          "type": "string",
          "description": "Username to connect to MarkLogic. Defaults to the shared vault secret."
        },
        "password": {
          "type": "string",
          "description": "Password to connect to MarkLogic. Defaults to the shared vault secret."
        },
        "manual_trigger": {
          "type": "boolean",
          "description": "Task must be triggered manually (Concourse only)."
        },
        "retries": {
          "type": "integer",
          "description": "Number of times to retry the task if it fails."
        },
        "notify_on_success": {
          "type": "boolean",
          "description": "Deprecated: use notifications instead.",
          "deprecated": true,
          "deprecationMessage": "use notifications instead"
        },
        "notifications": {
          "$ref": "#/$defs/Notifications",
          "description": "Notification channels for this task."
        },
        "timeout": {
          "type": "string",
          "description": "Timeout duration for the task. If exceeded the task fails. Defaults to 1h."
        },
        "build_history": {
          "type": "integer",
          "description": "Number of build logs to retain. Defaults to 20 (Concourse only)."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type",
        "ml_modules_version",
        "targets"
      ],
      "description": "deploy-ml-modules deploys a version of the shared ml modules library from\nartifactory."
    },
    "DeployMLZip": {
      "properties": {
        "type": {
          "type": "string",
          "const": "deploy-ml-zip",
          "description": "deploy-ml-zip deploys local XQuery files to MarkLogic using ml-deploy."
        },
        "name": {
          "type": "string",
          "description": "Optional display name."
        },
        "deploy_zip": {
          "type": "string",
          "description": "Path to the zip file containing XQuery source files, relative to the manifest."
        },
        "targets": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "MarkLogic instances to deploy to."
        },
        "app_name": {
          "type": "string",
          "description": "App name in MarkLogic. Defaults to the pipeline name."
        },
        "app_version": {
          "type": "string",
          "description": "App version in MarkLogic. Defaults to the git revision. Cannot be set with use_build_version."
        },
        "use_build_version": {
          "type": "boolean",
          "description": "Use $BUILD_VERSION instead of $GIT_REVISION for the app version. Cannot be set with app_version."
        },
        "username": {
          "type": "string",
          "description": "Username to connect to MarkLogic. Defaults to the shared vault secret."
        },
        "password": {
          "type": "string",
          "description": "Password to connect to MarkLogic. Defaults to the shared vault secret."
        },
        "manual_trigger": {
          "type": "boolean",
          "description": "Task must be triggered manually (Concourse only)."
        },
        "retries": {
          "type": "integer",
          "description": "Number of times to retry the task if it fails."
        },
        "notify_on_success": {
          "type": "boolean",
          "description": "Deprecated: use notifications instead.",
          "deprecated": true,
          "deprecationMessage": "use notifications instead"
        },
        "notifications": {
          "$ref": "#/$defs/Notifications",
          "description": "Notification channels for this task."
        },
        "timeout": {
          "type": "string",
          "description": "Timeout duration for the task. If exceeded the task fails. Defaults to 1h."
        },
        "build_history": {
          "type": "integer",
          "description": "Number of build logs to retain. Defaults to 20 (Concourse only)."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type",
        "deploy_zip",
        "targets"
      ],
      "description": "deploy-ml-zip deploys local XQuery files to MarkLogic using ml-deploy."
    },
    "Docker": {
      "properties": {
        "image": {
          "type": "string",
          "description": "Path of docker image in registry including tag."
        },
        "username": {
          "type": "string",
          "description": "Username for private Docker registries."
        },
        "password": {
          "type": "string",
          "description": "Password for private Docker registries."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "image"
      ],
      "description": "Docker image configuration"
    },
    "DockerCompose": {
      "properties": {
        "type": {
          "type": "string",
          "const": "docker-compose",
          "description": "docker-compose executes docker-compose based on a docker-compose.yml file.\nThis file must be present in the same directory as the halfpipe manifest."
        },
        "name": {
          "type": "string",
          "description": "Optional display name."
        },
        "command": {
          "type": "string",
          "description": "Command to run against the service. If omitted the default service command is used."
        },
        "vars": {
          "$ref": "#/$defs/Vars",
          "description": "Environment variables available to docker-compose."
        },
        "service": {
          "type": "string",
          "description": "Name of the docker-compose service to run. Defaults to app."
        },
        "compose_file": {
          "type": "string",
          "description": "Space-separated list of docker-compose files"
        },
        "save_artifacts": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Paths to files or directories to save for use in subsequent tasks."
        },
        "restore_artifacts": {
          "type": "boolean",
          "description": "Restore artifacts saved by previous tasks."
        },
        "save_artifacts_on_failure": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Paths to save when the task fails, useful for test reports."
        },
        "manual_trigger": {
          "type": "boolean",
          "description": "Task must be triggered manually (Concourse only)."
        },
        "retries": {
          "type": "integer",
          "description": "Number of times to retry the task if it fails."
        },
        "notify_on_success": {
          "type": "boolean",
          "description": "Deprecated: use notifications instead.",
          "deprecated": true,
          "deprecationMessage": "use notifications instead"
        },
        "notifications": {
          "$ref": "#/$defs/Notifications",
          "description": "Notification channels for this task."
        },
        "timeout": {
          "type": "string",
          "description": "Timeout duration for the task. If exceeded the task fails. Defaults to 1h."
        },
        "build_history": {
          "type": "integer",
          "description": "Number of build logs to retain. Defaults to 20 (Concourse only)."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type"
      ],
      "description": "docker-compose executes docker-compose based on a docker-compose.yml file.\nThis file must be present in the same directory as the halfpipe manifest."
    },
    "DockerPush": {
      "properties": {
        "type": {
          "type": "string",
          "const": "docker-push",
          "description": "docker-push builds a Docker image and pushes it to a docker registry. The\nimage will be tagged with the latest tag, the gitref and pipeline version\nby default."
        },
        "name": {
          "type": "string",
          "description": "Optional display name."
        },
        "image": {
          "type": "string",
          "description": "Docker image to build and push. Recommended format: eu.gcr.io/halfpipe-io/\u003cteam\u003e/\u003cimage-name\u003e."
        },
        "username": {
          "type": "string",
          "description": "Username for the target Docker registry."
        },
        "password": {
          "type": "string",
          "description": "Password for the target Docker registry."
        },
        "ignore_vulnerabilities": {
          "type": "boolean",
          "description": "Do not fail the build if critical vulnerabilities are found during image scanning."
        },
        "scan_timeout": {
          "type": "integer",
          "description": "Number of minutes a Trivy vulnerability scan is allowed to run before timing out."
        },
        "vars": {
          "$ref": "#/$defs/Vars",
          "description": "Docker build-time variables (ARGs). Do not use for secrets - values are visible in docker history."
        },
        "secrets": {
          "$ref": "#/$defs/Vars",
          "description": "Docker build-time secrets, mounted securely during build."
        },
        "restore_artifacts": {
          "type": "boolean",
          "description": "Restore artifacts saved by previous tasks."
        },
        "dockerfile_path": {
          "type": "string",
          "description": "Path to the Dockerfile, relative to the manifest. Defaults to Dockerfile."
        },
        "build_path": {
          "type": "string",
          "description": "Path to the folder to use as the Docker build context, relative to the manifest."
        },
        "tag": {
          "type": "string",
          "description": "Deprecated: no longer used - safe to delete.",
          "deprecated": true,
          "deprecationMessage": "no longer used - safe to delete"
        },
        "platforms": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Target platforms to build for, e.g. linux/amd64, linux/arm64. Defaults to linux/amd64."
        },
        "use_cache": {
          "type": "boolean",
          "description": "Enable layer caching to speed up builds by reusing layers from previous builds."
        },
        "manual_trigger": {
          "type": "boolean",
          "description": "Task must be triggered manually (Concourse only)."
        },
        "retries": {
          "type": "integer",
          "description": "Number of times to retry the task if it fails."
        },
        "notify_on_success": {
          "type": "boolean",
          "description": "Deprecated: use notifications instead.",
          "deprecated": true,
          "deprecationMessage": "use notifications instead"
        },
        "notifications": {
          "$ref": "#/$defs/Notifications",
          "description": "Notification channels for this task."
        },
        "timeout": {
          "type": "string",
          "description": "Timeout duration for the task. If exceeded the task fails. Defaults to 1h."
        },
        "build_history": {
          "type": "integer",
          "description": "Number of build logs to retain. Defaults to 20 (Concourse only)."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type",
        "image"
      ],
      "description": "docker-push builds a Docker image and pushes it to a docker registry. The\nimage will be tagged with the latest tag, the gitref and pipeline version\nby default."
    },
    "DockerTrigger": {
      "properties": {
        "type": {
          "type": "string",
          "const": "docker",
          "description": "docker trigger runs the pipeline when a docker image has been updated."
        },
        "image": {
          "type": "string",
          "description": "Docker image to watch for updates."
        },
        "username": {
          "type": "string",
          "description": "Username for private Docker registries."
        },
        "password": {
          "type": "string",
          "description": "Password for private Docker registries."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type",
        "image"
      ],
      "description": "docker trigger runs the pipeline when a docker image has been updated."
    },
    "FeatureToggles": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "description": "FeatureToggles enable optional pipeline behaviours.\n\n| Toggle | Description |\n|--------|-------------|\n| `update-pipeline` | Inserts a job that keeps the pipeline/workflow in sync with the halfpipe manifest. Sets BUILD_VERSION. |\n| `update-pipeline-and-tag` | Like update-pipeline, but also tags the git repo with `\u003cPIPELINE_NAME\u003e/v\u003cBUILD_VERSION\u003e`. |\n| `github-statuses` | Updates GitHub commit statuses from Concourse job results (Actions does this by default). |\n| `ghas` | Enables GitHub Advanced Security scanning on docker-push tasks. |"
    },
    "GitHubEnvironment": {
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the GitHub environment."
        },
        "url": {
          "type": "string",
          "description": "URL associated with the GitHub environment."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "description": "GitHub environment to associate with this deployment."
    },
    "GitTrigger": {
      "properties": {
        "type": {
          "type": "string",
          "const": "git",
          "description": "git trigger defines which git repo halfpipe will operate on. By convention\nthere is always a git trigger as default. To disable it, set manual_trigger\nto true."
        },
        "uri": {
          "type": "string",
          "description": "Git repository URI. Defaults to the URI resolved from .git/config."
        },
        "private_key": {
          "type": "string",
          "description": "SSH private key for cloning the repository. Defaults to ((github.private_key))."
        },
        "watched_paths": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Only trigger when changes occur in these paths (globs supported)."
        },
        "ignored_paths": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Do not trigger when changes occur only in these paths (globs supported)."
        },
        "git_crypt_key": {
          "type": "string",
          "description": "Base64-encoded git-crypt key to unlock an encrypted repository."
        },
        "branch": {
          "type": "string",
          "description": "Branch to track. Required when running halfpipe on a non-default branch."
        },
        "shallow": {
          "type": "boolean",
          "description": "Shallow clone the repository (--depth 1). Defaults to false in Concourse and true in GitHub Actions."
        },
        "manual_trigger": {
          "type": "boolean",
          "description": "Disable automatic triggering on commits."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type"
      ],
      "description": "git trigger defines which git repo halfpipe will operate on. By convention\nthere is always a git trigger as default. To disable it, set manual_trigger\nto true."
    },
    "NotificationChannel": {
      "properties": {
        "teams": {
          "type": "string",
          "description": "Microsoft Teams channel webhook URL."
        },
        "message": {
          "type": "string",
          "description": "Optional message to include in the notification."
        },
        "slack": {
          "type": "string",
          "description": "Deprecated: Slack notifications are no longer supported.",
          "deprecated": true,
          "deprecationMessage": "Slack notifications are no longer supported"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "description": "notification channel defines where to send a notification."
    },
    "NotificationChannels": {
      "items": {
        "$ref": "#/$defs/NotificationChannel"
      },
      "type": "array"
    },
    "Notifications": {
      "properties": {
        "success": {
          "$ref": "#/$defs/NotificationChannels",
          "description": "Notification channels to notify on task success."
        },
        "failure": {
          "$ref": "#/$defs/NotificationChannels",
          "description": "Notification channels to notify on task failure."
        },
        "on_success": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Deprecated: Slack notifications are no longer supported.",
          "deprecated": true,
          "deprecationMessage": "Slack notifications are no longer supported"
        },
        "on_success_message": {
          "type": "string",
          "description": "Deprecated: Slack notifications are no longer supported.",
          "deprecated": true,
          "deprecationMessage": "Slack notifications are no longer supported"
        },
        "on_failure": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Deprecated: Slack notifications are no longer supported.",
          "deprecated": true,
          "deprecationMessage": "Slack notifications are no longer supported"
        },
        "on_failure_message": {
          "type": "string",
          "description": "Deprecated: Slack notifications are no longer supported.",
          "deprecated": true,
          "deprecationMessage": "Slack notifications are no longer supported"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "description": "notifications configure which channels to notify on task success or failure."
    },
    "Parallel": {
      "properties": {
        "type": {
          "type": "string",
          "const": "parallel",
          "description": "parallel enables running tasks in parallel. All tasks start simultaneously;\nthe group succeeds when all complete."
        },
        "tasks": {
          "items": {
            "oneOf": [
              {
                "$ref": "#/$defs/Run"
              },
              {
                "$ref": "#/$defs/DeployCF"
              },
              {
                "$ref": "#/$defs/DeployKatee"
              },
              {
                "$ref": "#/$defs/DockerPush"
              },
              {
                "$ref": "#/$defs/DockerCompose"
              },
              {
                "$ref": "#/$defs/ConsumerIntegrationTest"
              },
              {
                "$ref": "#/$defs/DeployMLZip"
              },
              {
                "$ref": "#/$defs/DeployMLModules"
              },
              {
                "$ref": "#/$defs/Parallel"
              },
              {
                "$ref": "#/$defs/Sequence"
              },
              {
                "$ref": "#/$defs/Buildpack"
              },
              {
                "$ref": "#/$defs/CopyContainerImage"
              }
            ]
          },
          "type": "array",
          "description": "Tasks to run in parallel. All tasks start simultaneously; the group succeeds when all complete."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type",
        "tasks"
      ],
      "description": "parallel enables running tasks in parallel. All tasks start simultaneously;\nthe group succeeds when all complete."
    },
    "PipelineTrigger": {
      "properties": {
        "type": {
          "type": "string",
          "const": "pipeline",
          "description": "pipeline trigger runs the pipeline when another pipeline job has completed.\nNote that you cannot trigger on pipelines from another team."
        },
        "concourse_url": {
          "type": "string",
          "description": "Concourse URL. Defaults to the current Concourse instance."
        },
        "username": {
          "type": "string",
          "description": "Concourse username."
        },
        "password": {
          "type": "string",
          "description": "Concourse password."
        },
        "team": {
          "type": "string",
          "description": "Team that owns the pipeline to trigger from. Must be the same team."
        },
        "pipeline": {
          "type": "string",
          "description": "Name of the pipeline to trigger from."
        },
        "job": {
          "type": "string",
          "description": "Job name within the pipeline to trigger from."
        },
        "status": {
          "type": "string",
          "description": "Job status to trigger on. Allowed values: succeeded, failed, errored, aborted. Defaults to succeeded."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type",
        "pipeline",
        "job"
      ],
      "description": "pipeline trigger runs the pipeline when another pipeline job has completed.\nNote that you cannot trigger on pipelines from another team."
    },
    "Run": {
      "properties": {
        "type": {
          "type": "string",
          "const": "run",
          "description": "run is the most generic piece of work you can do. It represents a job in a\npipeline where a script will be run in a docker container. If the script\nreturns a non-zero exit code the task will be considered failed and any\nsubsequent tasks will not run."
        },
        "name": {
          "type": "string",
          "description": "Optional display name."
        },
        "script": {
          "type": "string",
          "description": "Path to the script to execute, relative to the manifest. Prefix with \\ to run a system command e.g. \\make."
        },
        "docker": {
          "$ref": "#/$defs/Docker",
          "description": "Docker configuration for the task to run in."
        },
        "privileged": {
          "type": "boolean",
          "description": "Run the task as root. Not recommended but sometimes necessary e.g. for docker-in-docker."
        },
        "vars": {
          "$ref": "#/$defs/Vars",
          "description": "Environment variables available to the script."
        },
        "save_artifacts": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Paths to files or directories to save for use in subsequent tasks."
        },
        "restore_artifacts": {
          "type": "boolean",
          "description": "Restore artifacts saved by previous tasks."
        },
        "save_artifacts_on_failure": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Paths to save when the task fails, useful for test reports."
        },
        "manual_trigger": {
          "type": "boolean",
          "description": "Task must be triggered manually (Concourse only)."
        },
        "retries": {
          "type": "integer",
          "description": "Number of times to retry the task if it fails."
        },
        "notify_on_success": {
          "type": "boolean",
          "description": "Deprecated: use notifications instead.",
          "deprecated": true,
          "deprecationMessage": "use notifications instead"
        },
        "notifications": {
          "$ref": "#/$defs/Notifications",
          "description": "Notification channels for this task."
        },
        "timeout": {
          "type": "string",
          "description": "Timeout duration for the task. If exceeded the task fails. Defaults to 1h."
        },
        "build_history": {
          "type": "integer",
          "description": "Number of build logs to retain. Defaults to 20 (Concourse only)."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type",
        "script",
        "docker"
      ],
      "description": "run is the most generic piece of work you can do. It represents a job in a\npipeline where a script will be run in a docker container. If the script\nreturns a non-zero exit code the task will be considered failed and any\nsubsequent tasks will not run."
    },
    "Sequence": {
      "properties": {
        "type": {
          "type": "string",
          "const": "sequence",
          "description": "sequence enables running tasks in sequence within a parallel group. It can\nonly be used inside a parallel task."
        },
        "tasks": {
          "items": {
            "oneOf": [
              {
                "$ref": "#/$defs/Run"
              },
              {
                "$ref": "#/$defs/DeployCF"
              },
              {
                "$ref": "#/$defs/DeployKatee"
              },
              {
                "$ref": "#/$defs/DockerPush"
              },
              {
                "$ref": "#/$defs/DockerCompose"
              },
              {
                "$ref": "#/$defs/ConsumerIntegrationTest"
              },
              {
                "$ref": "#/$defs/DeployMLZip"
              },
              {
                "$ref": "#/$defs/DeployMLModules"
              },
              {
                "$ref": "#/$defs/Parallel"
              },
              {
                "$ref": "#/$defs/Sequence"
              },
              {
                "$ref": "#/$defs/Buildpack"
              },
              {
                "$ref": "#/$defs/CopyContainerImage"
              }
            ]
          },
          "type": "array",
          "description": "Tasks to run in sequence within a parallel group. Can only be used inside a parallel task."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type",
        "tasks"
      ],
      "description": "sequence enables running tasks in sequence within a parallel group. It can\nonly be used inside a parallel task."
    },
    "TaskList": {
      "items": true,
      "type": "array"
    },
    "TimerTrigger": {
      "properties": {
        "type": {
          "type": "string",
          "const": "timer",
          "description": "timer trigger runs the pipeline on a schedule. The cron expression must be\nvalid; remember to specify times in UTC. See [crontab.guru] for help\nwriting cron expressions.\n\n[crontab.guru]: https://crontab.guru/"
        },
        "cron": {
          "type": "string",
          "description": "Cron expression for the timer schedule. Times must be in UTC."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "type",
        "cron"
      ],
      "description": "timer trigger runs the pipeline on a schedule. The cron expression must be\nvalid; remember to specify times in UTC. See [crontab.guru] for help\nwriting cron expressions.\n\n[crontab.guru]: https://crontab.guru/"
    },
    "TriggerList": {
      "items": true,
      "type": "array"
    },
    "Vars": {
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          }
        ]
      },
      "type": "object",
      "description": "Key-value pairs of environment variables (values are coerced to strings)"
    }
  },
  "properties": {
    "team": {
      "type": "string",
      "description": "The platform team that owns this pipeline."
    },
    "pipeline": {
      "type": "string",
      "description": "The name of the pipeline."
    },
    "slack_channel": {
      "type": "string",
      "description": "Deprecated: Slack notifications are no longer supported.",
      "deprecated": true,
      "deprecationMessage": "Slack notifications are no longer supported"
    },
    "teams_webhook": {
      "type": "string",
      "description": "A Microsoft Teams webhook URL for pipeline-level notifications."
    },
    "slack_success_message": {
      "type": "string",
      "description": "Deprecated: Slack notifications are no longer supported.",
      "deprecated": true,
      "deprecationMessage": "Slack notifications are no longer supported"
    },
    "slack_failure_message": {
      "type": "string",
      "description": "Deprecated: Slack notifications are no longer supported.",
      "deprecated": true,
      "deprecationMessage": "Slack notifications are no longer supported"
    },
    "feature_toggles": {
      "items": {
        "type": "string",
        "enum": [
          "update-pipeline",
          "update-pipeline-and-tag",
          "github-statuses",
          "ghas"
        ]
      },
      "type": "array",
      "description": "Optional feature toggles"
    },
    "triggers": {
      "items": {
        "oneOf": [
          {
            "$ref": "#/$defs/GitTrigger"
          },
          {
            "$ref": "#/$defs/TimerTrigger"
          },
          {
            "$ref": "#/$defs/DockerTrigger"
          },
          {
            "$ref": "#/$defs/PipelineTrigger"
          }
        ]
      },
      "type": "array",
      "description": "The triggers that cause this pipeline to run. Defaults to git."
    },
    "tasks": {
      "items": {
        "oneOf": [
          {
            "$ref": "#/$defs/Run"
          },
          {
            "$ref": "#/$defs/DeployCF"
          },
          {
            "$ref": "#/$defs/DeployKatee"
          },
          {
            "$ref": "#/$defs/DockerPush"
          },
          {
            "$ref": "#/$defs/DockerCompose"
          },
          {
            "$ref": "#/$defs/ConsumerIntegrationTest"
          },
          {
            "$ref": "#/$defs/DeployMLZip"
          },
          {
            "$ref": "#/$defs/DeployMLModules"
          },
          {
            "$ref": "#/$defs/Parallel"
          },
          {
            "$ref": "#/$defs/Sequence"
          },
          {
            "$ref": "#/$defs/Buildpack"
          },
          {
            "$ref": "#/$defs/CopyContainerImage"
          }
        ]
      },
      "type": "array",
      "description": "The tasks that make up this pipeline."
    },
    "platform": {
      "type": "string",
      "enum": [
        "",
        "concourse",
        "actions"
      ],
      "description": "The CI platform to target. Defaults to concourse."
    },
    "notifications": {
      "$ref": "#/$defs/Notifications",
      "description": "Default notifications for all tasks."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "team",
    "pipeline",
    "tasks"
  ],
  "title": "Halfpipe Manifest",
  "description": "Schema for the halfpipe CI/CD manifest"
}