repository-categories/config.schema.json at main · loat-dev/repository-categories · 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
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "title": "Category Config",
  "description": "Configuration for the repository categories GitHub action config.json file.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "$schema": {
      "title": "Schema",
      "description": "Path to the schema against which this document should be validated.",
      "type": "string"
    },
    "organizationName": {
      "title": "Name of the organization",
      "description": "What organization to use.",
      "type": "string"
    },
    "onlyPublicRepositories": {
      "title": "Only Public Repositories",
      "description": "If only public repositories should be queried. Private repositories will be ignored.\nDefault: true",
      "type": "boolean",
      "default": true
    },
    "templateFiles": {
      "title": "Template Files",
      "description": "Template files to use for the categories.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "readme": {
          "title": "README",
          "description": "Template file for the readme.\nDefault: './.github/categories/templates/readme.md'",
          "type": "string",
          "default": "./.github/categories/templates/readme.md"
        },
        "category": {
          "title": "Category",
          "description": "Template file for the category.\nDefault: './.github/categories/templates/category.md'",
          "type": "string",
          "default": "./.github/categories/templates/category.md"
        },
        "repository": {
          "title": "Repository",
          "description": "Template file for the repository.\nDefault: './.github/categories/templates/repository.md'",
          "type": "string",
          "default": "./.github/categories/templates/repository.md"
        }
      }
    },
    "labelSearchPattern": {
      "title": "Label Search Pattern",
      "description": "The category regex search pattern to use when searching for category labels in the repositories. Specify the categories as comma separated values in the label description.\nDefault: 'category'",
      "type": "string",
      "default": "category"
    },
    "repositoryBlacklist": {
      "title": "Repository Blacklist",
      "description": "List of repository names to blacklist.\nDefault: ['.github']",
      "type": "array",
      "uniqueItems": true,
      "default": [
        ".github"
      ],
      "items": {
        "type": "string",
        "description": "Repository name to blacklist.",
        "pattern": "^[a-zA-Z0-9-_.]+$"
      }
    },
    "categories": {
      "title": "Categories",
      "description": "Mappings between the category IDs and the category names.\nDefault: {\"\": \"No Category\"}",
      "type": "object",
      "default": {
        "": "No Category"
      },
      "required": [ "" ],
      "properties": {
        "": {
          "description": "Default category to use if no category is found.",
          "type": "string",
          "default": "No Category"
        }
      },
      "patternProperties": {
        "": {
          "description": "Mapping from the category ID to the category name.",
          "type": "string"
        }
      }
    }
  }
}