-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathskylounge.schema.json
125 lines (125 loc) · 4.83 KB
/
skylounge.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$comment": "https://docs.skylounge.io/developing-blueprints/skyloungeyml/",
"$id": "https://github.com/sky-lounge/public-skylounge-library/schemas/skylounge.schema.json",
"title": "skylounge.yml",
"description": "Configures the automation applied to a repository. The `skylounge.yml` specifies the `blueprint.yml` of workflows to apply. For any workflows that require configuration of `skylounge-job`s, `skylounge-step`s, or `parameters`, it also provides these. Workflows that do not require such configuration (*i.e.*, are \"pure\" [GitHub Actions]() without `SkyLounge` extensions) do not need to be included.",
"type": "object",
"properties": {
"blueprint-uri": {
"oneOff": [
{ "type": "null" },
{
"type": "string",
"format": "uri-reference",
"description": "The URI in GitHub of the `blueprint.yml` file for this repository. For example: `sky-lounge/public-skylounge-library/blueprints/hello-skylounge/blueprint.yml`."
}
]
},
"workflows": {
"type": "array",
"description": "An array of workflows that require configuration. Workflows that do not require configuration do not need to be listed here.",
"items": {
"type": "object",
"description": "Provides configuration for a single workflow.",
"properties": {
"workflow": {
"type": "string",
"description": "Name of the workflow to be configured."
},
"jobs": {
"type": "array",
"description": "An array of jobs in the workflow to be configured.",
"items": {
"type": "object",
"description": "Configuration for a single job.",
"properties": {
"job": {
"type": "string",
"description": "Name of the job to be configured.",
"minLength": 1
},
"steps": {
"type": "array",
"description": "An array of steps that require configuration. Steps that do not require configuration do not need to be listed here.",
"items": {
"type": "object",
"description": "Configuration for a single step.",
"properties": {
"step": {
"type": "string",
"description": "Name of the step to be configured.",
"minLength": 1
},
"uri": {
"oneOff": [
{ "type": "null" },
{
"type": "string",
"format": "uri-reference",
"description": "URI in GitHub defining the `skylounge-step` to be applied."
}
]
}
},
"required": [ "step", "uri"]
},
"uniqueItems": true
},
"uri": {
"oneOff": [
{ "type": "null" },
{
"type": "string",
"format": "uri-reference",
"description": "URI in GitHub defining the `skylounge-job` to be applied."
}
]
},
"params": {
"type": "object",
"description": "A dictionary of parameters to be configured for this job. Parameter names and values can be any string.",
"patternProperties": {
"..*": {
"oneOff": [
{ "type": "string" },
{ "type": "null" }
]
}
}
}
}
},
"uniqueItems": true
},
"params": {
"type": "object",
"description": "A dictionary of parameters to be configured for this workflow. Parameter names and values can be any string.",
"patternProperties": {
"..*": {
"oneOff": [
{ "type": "string" },
{ "type": "null" }
]
}
}
}
}
},
"uniqueItems": true
},
"params": {
"type": "object",
"description": "A dictionary of global parameters to be configured. Parameter names and values can be any string.",
"patternProperties": {
"..*": {
"oneOff": [
{ "type": "string" },
{ "type": "null" }
]
}
}
}
},
"required": [ "blueprint-uri" ]
}