envoke/envoke.schema.json at main · glennib/envoke · GitHub

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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
{
  "$defs": {
    "Override": {
      "description": "An override provides alternative sources for a variable, activated via\nthe `--override` CLI flag.",
      "properties": {
        "default": {
          "anyOf": [
            {
              "$ref": "#/$defs/Source"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Fallback source for this override when the environment has no entry."
        },
        "envs": {
          "additionalProperties": {
            "$ref": "#/$defs/Source"
          },
          "default": {},
          "description": "Map of environment names to value sources for this override.",
          "type": "object"
        }
      },
      "type": "object"
    },
    "Source": {
      "description": "How to obtain the value for a variable in a given environment.",
      "oneOf": [
        {
          "additionalProperties": false,
          "description": "A fixed string value.",
          "properties": {
            "literal": {
              "type": "string"
            }
          },
          "required": [
            "literal"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "description": "A command to execute; stdout is captured with trailing whitespace\nstripped.",
          "properties": {
            "cmd": {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "cmd"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "description": "A shell script to execute via `sh -c`; stdout is captured with trailing\nwhitespace stripped.",
          "properties": {
            "sh": {
              "type": "string"
            }
          },
          "required": [
            "sh"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "description": "A minijinja (Jinja2) template string. Reference other variables with\n`{{ VAR_NAME }}` or metadata like `{{ meta.environment }}`.",
          "properties": {
            "template": {
              "type": "string"
            }
          },
          "required": [
            "template"
          ],
          "type": "object"
        },
        {
          "const": "skip",
          "description": "Silently omit this variable from output. YAML surface: the bare string\n`skip` (not `skip: true`).",
          "type": "string"
        }
      ]
    },
    "Variable": {
      "description": "A single environment variable with per-environment sources.\n\nResolution requires either an `envs` entry matching the target environment\nor a `default`. If neither exists, resolution fails with a `NoConfig` error.",
      "properties": {
        "default": {
          "anyOf": [
            {
              "$ref": "#/$defs/Source"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Fallback source used when the requested environment has no entry in\n`envs`."
        },
        "description": {
          "description": "Human-readable description, rendered as a comment in output.",
          "type": [
            "string",
            "null"
          ]
        },
        "envs": {
          "additionalProperties": {
            "$ref": "#/$defs/Source"
          },
          "default": {},
          "description": "Map of environment names to value sources.",
          "type": "object"
        },
        "overrides": {
          "additionalProperties": {
            "$ref": "#/$defs/Override"
          },
          "description": "Named overrides that can be activated via `--override` on the CLI.\nEach override provides alternative `default`/`envs` sources that\ntake precedence over the base sources when active.",
          "type": "object"
        },
        "tags": {
          "default": [],
          "description": "Tags for conditional inclusion. When `--tag` flags are passed on the\nCLI, only variables with at least one matching tag (or no tags) are\nincluded.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Top-level envoke configuration, typically loaded from `envoke.yaml`.",
  "properties": {
    "variables": {
      "additionalProperties": {
        "$ref": "#/$defs/Variable"
      },
      "description": "Map of variable names to their definitions.",
      "type": "object"
    }
  },
  "required": [
    "variables"
  ],
  "title": "Config",
  "type": "object"
}