repository.github/resources/repository-schema.json at master · i96751414/repository.github · 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
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "type": "array",
  "title": "The repository definition",
  "description": "The list containing all add-ons included in the repository.",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "title": "Add-on ID",
        "description": "The add-on identifier as in addon.xml."
      },
      "username": {
        "type": "string",
        "title": "Repository username",
        "description": "The github repository username."
      },
      "branch": {
        "type": "string",
        "title": "Repository branch",
        "description": "The github repository branch. If not defined, it will be either 1) the commit of the latest release, 2) the respective tag, 3) the repository default branch, or 4) if all the previous are unable to fetch, \"main\" branch."
      },
      "assets": {
        "type": "object",
        "title": "Repository assets",
        "description": "Dictionary containing string/string key-value pairs, where the key corresponds to the relative asset location and the value corresponds to the real asset location. One can also set \"zip\" asset, which is a special case for the add-on zip. If an asset is not defined, its location will be automatically evaluated.\nNote: assets are treated as \"new style\" format strings with the following keywords - id, username, repository, ref, system, arch and version (version is available for zip assets only).",
        "additionalProperties": {
          "type": "string",
          "title": "Asset location",
          "description": "The real asset location. Can be either 1) a relative path, a HTTP/HTTPS URL, or a release asset with the following format - \"release_asset://<release_tag>/<asset_name>\"."
        }
      },
      "asset_prefix": {
        "type": "string",
        "title": "Asset prefix",
        "description": "Prefix to use on the real asset location when it is automatically evaluated."
      },
      "repository": {
        "type": "string",
        "title": "Github repository",
        "description": "GitHub repository name. If not set, it is assumed to be the same as the add-on id."
      },
      "tag_pattern": {
        "type": "string",
        "title": "Tag RegEx pattern",
        "description": "The pattern for matching eligible tags. If not set, all tags are considered."
      },
      "token": {
        "type": "string",
        "title": "Access Token",
        "description": "The token to use for accessing the repository. If not provided, the repository must have public access."
      },
      "platforms": {
        "type": "array",
        "title": "Supported platforms",
        "description": "Platforms where the add-on is supported. If not set, it is assumed all platforms are supported.",
        "items": {
          "type": "string"
        }
      }
    },
    "required": [
      "id",
      "username"
    ],
    "additionalProperties": false
  }
}