Workflow schema¶
The Workflow schema describes workflows as received by the Receptionist
service.
They can be provided as JSON or YAML files.
{
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"title": "JSON SCHEMA for opentestfactory.org/v1 Workflow manifests",
"description": "An Orchestrator Workflow. Must have a name and at least one job.",
"type": "object",
"properties": {
"apiVersion": {
"enum": [
"opentestfactory.org/v1alpha1",
"opentestfactory.org/v1beta1",
"opentestfactory.org/v1"
]
},
"kind": {
"const": "Workflow"
},
"metadata": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"namespace": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]*$"
},
"labels": {
"type": "object",
"patternProperties": {
"^([a-zA-Z0-9-.]+/)?[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9])?$": {
"type": "string"
}
},
"minProperties": 1,
"additionalProperties": false
}
},
"additionalProperties": true,
"required": [
"name"
]
},
"concurrency": {
"$ref": "#/definitions/concurrency"
},
"defaults": {
"$ref": "#/definitions/defaults"
},
"variables": {
"$ref": "#/definitions/variables"
},
"secrets": {
"$ref": "#/definitions/secrets"
},
"timeout-minutes": {
"$ref": "#/definitions/number-expression"
},
"strategy": {
"$ref": "#/definitions/strategy"
},
"hooks": {
"$ref": "#/definitions/hooks"
},
"resources": {
"$ref": "#/definitions/resources"
},
"jobs": {
"$ref": "#/definitions/jobs"
},
"inputs": {
"$ref": "#/definitions/inputs"
},
"outputs": {
"$ref": "#/definitions/outputs"
}
},
"required": [
"metadata",
"jobs"
],
"additionalProperties": false,
"definitions": {
"defaults": {
"type": "object",
"propertyNames": {
"pattern": "^[a-zA-Z][a-zA-Z0-9-]*$"
}
},
"job-generator": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"if": {
"type": "string"
},
"concurrency": {
"$ref": "#/definitions/concurrency"
},
"runs-on": {
"$ref": "#/definitions/runs-on"
},
"needs": {
"$ref": "#/definitions/needs"
},
"defaults": {
"$ref": "#/definitions/defaults"
},
"variables": {
"$ref": "#/definitions/variables"
},
"timeout-minutes": {
"$ref": "#/definitions/number-expression"
},
"strategy": {
"$ref": "#/definitions/strategy"
},
"jobs": {
"$ref": "#/definitions/jobs"
},
"generator": {
"type": "string"
},
"uses": {
"type": "string"
},
"with": {
"$ref": "#/definitions/with"
},
"outputs": {
"$ref": "#/definitions/outputs"
},
"continue-on-error": {
"$ref": "#/definitions/boolean-expression"
}
},
"oneOf": [
{
"required": [
"generator"
],
"not": {
"required": [
"outputs"
]
}
},
{
"required": [
"uses"
],
"not": {
"required": [
"outputs"
]
}
},
{
"required": [
"jobs"
],
"not": {
"required": [
"with"
]
}
}
],
"additionalProperties": false
},
"job-steps": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"if": {
"type": "string"
},
"concurrency": {
"$ref": "#/definitions/concurrency"
},
"runs-on": {
"$ref": "#/definitions/runs-on"
},
"needs": {
"$ref": "#/definitions/needs"
},
"defaults": {
"$ref": "#/definitions/defaults"
},
"variables": {
"$ref": "#/definitions/variables"
},
"timeout-minutes": {
"$ref": "#/definitions/number-expression"
},
"strategy": {
"$ref": "#/definitions/strategy"
},
"steps": {
"type": "array",
"minItems": 1,
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"if": {
"type": "string"
},
"uses": {
"type": "string"
},
"with": {
"$ref": "#/definitions/with"
},
"variables": {
"$ref": "#/definitions/variables"
},
"timeout-minutes": {
"$ref": "#/definitions/number-expression"
},
"continue-on-error": {
"$ref": "#/definitions/boolean-expression"
},
"working-directory": {
"type": "string"
}
},
"required": [
"uses"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"if": {
"type": "string"
},
"run": {
"type": "string"
},
"shell": {
"type": "string"
},
"variables": {
"$ref": "#/definitions/variables"
},
"timeout-minutes": {
"$ref": "#/definitions/number-expression"
},
"continue-on-error": {
"$ref": "#/definitions/boolean-expression"
},
"working-directory": {
"type": "string"
}
},
"required": [
"run"
],
"additionalProperties": false
}
]
}
},
"outputs": {
"$ref": "#/definitions/outputs"
},
"continue-on-error": {
"$ref": "#/definitions/boolean-expression"
}
},
"required": [
"steps"
],
"additionalProperties": false
},
"needs": {
"anyOf": [
{
"type": "string",
"pattern": "(^[a-zA-Z_][a-zA-Z0-9_-]*$)|(^\\$\\{\\{.*\\}\\}$)"
},
{
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"pattern": "(^[a-zA-Z_][a-zA-Z0-9_-]*$)|(^\\$\\{\\{.*\\}\\}$)"
}
}
]
},
"number-expression": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^\\$\\{\\{.*\\}\\}$"
}
]
},
"boolean-expression": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"pattern": "^\\$\\{\\{.*\\}\\}$"
}
]
},
"identifier-expression": {
"type": "string",
"pattern": "(^[a-zA-Z][a-zA-Z0-9-]*$)|(^\\$\\{\\{.*\\}\\}$)"
},
"runs-on": {
"anyOf": [
{
"$ref": "#/definitions/identifier-expression"
},
{
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/identifier-expression"
}
},
{
"type": "object"
}
]
},
"variables": {
"type": "object",
"patternProperties": {
"^[a-zA-Z0-9_]+$": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"value": {
"type": "string"
},
"verbatim": {
"type": "boolean"
}
},
"required": [
"value"
],
"additionalProperties": false
}
]
}
},
"minProperties": 1
},
"secrets": {
"type": "object",
"patternProperties": {
"^[a-zA-Z0-9_]+$": {
"type": "string"
}
},
"minProperties": 1
},
"strategy": {
"type": "object",
"properties": {
"max-parallel": {
"$ref": "#/definitions/number-expression"
},
"fail-fast": {
"$ref": "#/definitions/boolean-expression"
},
"matrix": {
"type": "object",
"properties": {
"exclude": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*$": {
"type": "string"
}
}
}
},
"include": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*$": {
"type": "string"
}
}
}
}
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*$": {
"type": "array",
"minItems": 1,
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*$": {
"type": "string"
}
}
}
]
}
}
}
}
},
"minProperties": 1,
"additionalProperties": false
},
"concurrency": {
"type": "object",
"properties": {
"group": {
"type": "string"
},
"cancel-in-progress": {
"$ref": "#/definitions/boolean-expression"
}
},
"additionalProperties": false,
"required": [
"group"
]
},
"hooks": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"if": {
"type": "string"
},
"events": {
"type": "array",
"minItems": 1
},
"before": {
"type": "array",
"minItems": 1
},
"after": {
"type": "array",
"minItems": 1
}
},
"anyOf": [
{
"required": [
"name",
"events",
"before"
]
},
{
"required": [
"name",
"events",
"after",
"before"
]
},
{
"required": [
"name",
"events",
"after"
]
}
],
"additionalProperties": false
}
},
"jobs": {
"type": "object",
"patternProperties": {
"^[a-zA-Z_][a-zA-Z0-9_-]*$": {
"oneOf": [
{
"$ref": "#/definitions/job-generator"
},
{
"$ref": "#/definitions/job-steps"
}
]
}
},
"minProperties": 1
},
"with": {
"type": "object"
},
"inputs": {
"type": "object",
"patternProperties": {
"^[a-zA-Z_][a-zA-Z0-9_-]*$": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"required": {
"type": "boolean"
},
"default": {
"type": "string"
},
"depreciationMessage": {
"type": "string"
}
},
"required": [
"description"
],
"additionalProperties": false
}
},
"minProperties": 1
},
"outputs": {
"type": "object",
"patternProperties": {
"^[a-zA-Z_][a-zA-Z0-9_-]*$": {
"oneOf": [
{
"type": "object",
"properties": {
"description": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"additionalProperties": false
},
{
"type": "string"
}
]
}
},
"minProperties": 1
},
"resources": {
"type": "object",
"properties": {
"testmanagers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"testmanager": {
"type": "string"
},
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"endpoint": {
"type": "string"
}
},
"required": [
"testmanager",
"type",
"name",
"endpoint"
]
}
},
"repositories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"repository": {
"type": "string"
},
"type": {
"type": "string",
"pattern": "^[a-z][a-z0-9]*$"
},
"name": {
"type": "string"
},
"endpoint": {
"type": "string"
}
},
"required": [
"repository",
"type",
"name",
"endpoint"
]
}
},
"files": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
]
}
}
}
}
}
}