deploy/config-schema.json at main · cubing/deploy · 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
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Configuration",
  "description": "Configuration for @cubing/deploy",
  "type": "object",
  "properties": {
    "$schema": {
      "description": "A field for the [JSON schema](https://json-schema.org/) specification",
      "type": "string"
    }
  },
  "additionalProperties": {
    "$ref": "#/definitions/DeployTarget"
  },
  "definitions": {
    "DeployTarget": {
      "description": "Deploy target custom configuration.",
      "type": "object",
      "properties": {
        "username": {
          "description": "SSH username for the deployment",
          "type": "string"
        },
        "fromLocalDir": {
          "description": "Deploy from this directory instead of the default. (Default example: https://example.com/path/to/dir → ./dist/web/example.com/path/to/dir).",
          "type": "string"
        },
        "skipDefaultExcludes": {
          "description": "Skip all default excludes, or a subset. If any paths are included in `additionalExcludes`, that overrides this setting.",
          "anyOf": [
            {
              "enum": [true]
            },
            { "type": "array", "items": { "type": "string" } }
          ]
        },
        "additionalExcludes": {
          "description": "A list of additional paths to exclude.",
          "type": "array",
          "items": { "type": "string" }
        }
      }
    }
  }
}