aboutsummaryrefslogtreecommitdiff
path: root/gitinfo.schema.json
blob: c382f3bbccb2b55b8d847e186c33e2f3308eea0b (plain)
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": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://forgejo.zue.dev/zuedev/gitinfo/raw/branch/main/gitinfo.schema.json",
  "title": ".gitinfo",
  "description": "Schema for the .gitinfo file specification",
  "type": "object",
  "required": ["root"],
  "properties": {
    "root": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the root repository. This is the main hosting location that acts as the source of truth for the codebase."
    },
    "gitmail": {
      "type": "string",
      "format": "email",
      "description": "An email address associated with the repository for submitting git patches."
    },
    "icon": {
      "type": "string",
      "description": "A public URL or data URI formatted image (PNG, SVG, etc.) representing an icon for the repository.",
      "pattern": "^(https?://|data:image/)"
    },
    "description": {
      "type": "string",
      "description": "A brief description of the repository's purpose or contents."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of tags or keywords associated with the repository for easier categorization and searchability."
    },
    "mirrors": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "A list of URLs representing mirror repositories."
    },
    "maintainers": {
      "type": "array",
      "items": {
        "type": "array",
        "items": [
          {
            "type": "string",
            "description": "Maintainer name"
          },
          {
            "type": "string",
            "format": "email",
            "description": "Maintainer email"
          }
        ],
        "minItems": 2,
        "maxItems": 2
      },
      "description": "A list of maintainers or contributors to the repository, provided as a 2D array with names and email addresses in the format [[name, email], ...]."
    },
    "license": {
      "type": "string",
      "description": "The license under which the repository is distributed. Use the short identifier from SPDX License List for consistency."
    }
  },
  "additionalProperties": false
}