suborgs.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Safe-settings suborg-level configuration",
  "description": "Schema for .github/suborgs/*.yml — suborg-level safe-settings configuration. Defines which repos belong to the suborg and what settings to apply.",
  "type": "object",
  "properties": {
    "suborgrepos": {
      "type": "array",
      "description": "Glob patterns matching repository names. Repos whose names match any pattern are included in this suborg.",
      "items": {
        "type": "string"
      }
    },
    "suborgteams": {
      "type": "array",
      "description": "Team slugs. Repos that belong to any of these teams are included in this suborg.",
      "items": {
        "type": "string"
      }
    },
    "suborgproperties": {
      "type": "array",
      "description": "Custom property filters. Repos with matching custom property values are included in this suborg.",
      "items": {
        "type": "object",
        "properties": {
          "property_name": {
            "type": "string",
            "description": "The name of the custom property"
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Accepted values for this property"
          }
        }
      }
    },
    "repositories": {
      "$ref": "#/$defs/RepositorySettings"
    },
    "labels": {
      "$ref": "#/$defs/LabelSettings"
    },
    "collaborators": {
      "description": "Collaborators: give specific users access to any repository.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/CollaboratorSettings"
      }
    },
    "teams": {
      "description": "Teams",
      "type": "array",
      "items": {
        "$ref": "#/$defs/TeamSettings"
      }
    },
    "milestones": {
      "description": "Milestones: define milestones for Issues and Pull Requests",
      "type": "array",
      "items": {
        "$ref": "#/$defs/MilestoneSettings"
      }
    },
    "branches": {
      "description": "Branch protection rules",
      "type": "array",
      "items": {
        "$ref": "#/$defs/BranchSettings"
      }
    },
    "autolinks": {
      "description": "Autolinks",
      "type": "array",
      "items": {
        "$ref": "#/$defs/AutolinkSettings"
      }
    },
    "validator": {
      "$ref": "#/$defs/ValidatorSettings"
    },
    "rulesets": {
      "description": "Repository rulesets applied to every repository in the suborg",
      "type": "array",
      "items": {
        "$ref": "#/$defs/RulesetSettings"
      }
    },
    "environments": {
      "description": "Deployment environments",
      "type": "array",
      "items": {
        "$ref": "#/$defs/EnvironmentsSettings"
      }
    },
    "custom_properties": {
      "description": "Custom properties",
      "type": "array",
      "items": {
        "$ref": "#/$defs/CustomPropertiesSettings"
      }
    },
    "variables": {
      "description": "Repository or org-level Actions variables",
      "type": "array",
      "items": {
        "$ref": "#/$defs/VariablesSettings"
      }
    }
  },
  "$defs": {
    "RepositorySettings": {
      "description": "Repository settings. Use force_create to create the repository if it does not exist, and template to specify a template repository to use when creating it.",
      "allOf": [
        {
          "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/api.github.com/api.github.com.2026-03-10.json#/paths/~1repos~1{owner}~1{repo}/patch/requestBody/content/application~1json/schema"
        },
        {
          "type": "object",
          "properties": {
            "auto_init": {
              "description": "Create an initial commit with empty README. Keep this set to true in most cases since many of the policies below cannot be implemented on bare repos",
              "type": "boolean"
            },
            "gitignore_template": {
              "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, 'Haskell'.",
              "type": "string"
            },
            "license_template": {
              "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, 'mit' or 'mpl-2.0'.",
              "type": "string"
            },
            "topics": {
              "description": "A list of topics to set on the repository",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "security": {
              "description": "Settings for Code security and analysis",
              "type": "object",
              "properties": {
                "enableVulnerabilityAlerts": {
                  "type": "boolean"
                },
                "enableAutomatedSecurityFixes": {
                  "type": "boolean"
                }
              }
            },
            "force_create": {
              "description": "If true, create the repository if it does not already exist.",
              "type": "boolean"
            },
            "template": {
              "description": "Name of a template repository to use when creating a new repository.",
              "type": "string"
            }
          }
        }
      ]
    },
    "LabelSettings": {
      "description": "Labels: define labels for Issues and Pull Requests",
      "type": "object",
      "properties": {
        "include": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "color": {
                "description": "The hexadecimal color code for the label. If including a `#`, make sure to wrap it with quotes!",
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "oldname": {
                "description": "Include the old name to rename an existing label",
                "type": "string"
              }
            }
          }
        },
        "exclude": {
          "description": "Ignore any labels matching these regexes (don't delete them)",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "CollaboratorSettings": {
      "description": "A collaborator entry giving a specific user access to a repository.",
      "allOf": [
        {
          "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/api.github.com/api.github.com.2026-03-10.json#/paths/~1repos~1{owner}~1{repo}~1collaborators~1{username}/put/requestBody/content/application~1json/schema"
        },
        {
          "type": "object",
          "properties": {
            "username": {
              "type": "string"
            },
            "exclude": {
              "description": "You can exclude a list of repos for this collaborator and all repos except these repos would have this collaborator",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "include": {
              "description": "You can include a list of repos for this collaborator and only those repos would have this collaborator",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      ]
    },
    "TeamSettings": {
      "description": "A team entry",
      "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/api.github.com/api.github.com.2026-03-10.json#/paths/~1orgs~1{org}~1teams/post/requestBody/content/application~1json/schema"
    },
    "MilestoneSettings": {
      "description": "A milestone entry",
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "state": {
          "description": "The state of the milestone. Either `open` or `closed`",
          "type": "string"
        }
      }
    },
    "BranchSettings": {
      "description": "A branch protection rule entry",
      "type": "object",
      "properties": {
        "name": {
          "description": "If the name of the branch value is specified as `default`, then the app will create a branch protection rule to apply against the default branch in the repo",
          "type": "string"
        },
        "protection": {
          "anyOf": [
            {
              "enum": [null, {}, [], false],
              "description": "An empty value deletes the existing branch protection"
            },
            {
              "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/api.github.com/api.github.com.2026-03-10.json#/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection/put/requestBody/content/application~1json/schema"
            }
          ]
        }
      }
    },
    "AutolinkSettings": {
      "description": "An autolink reference entry",
      "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/api.github.com/api.github.com.2026-03-10.json#/paths/~1repos~1{owner}~1{repo}~1autolinks/post/requestBody/content/application~1json/schema"
    },
    "ValidatorSettings": {
      "description": "Repository name validation",
      "type": "object",
      "properties": {
        "pattern": {
          "type": "string"
        }
      }
    },
    "RulesetSettings": {
      "description": "A repository ruleset entry",
      "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/api.github.com/api.github.com.2026-03-10.json#/paths/~1repos~1{owner}~1{repo}~1rulesets/post/requestBody/content/application~1json/schema"
    },
    "EnvironmentsSettings": {
      "description": "A deployment environment configuration entry",
      "type": "object",
      "required": ["name"],
      "properties": {
        "name": {
          "description": "The name of the deployment environment",
          "type": "string"
        },
        "wait_timer": {
          "description": "The amount of time to delay a job after the job is initially triggered (in minutes)",
          "type": "integer"
        },
        "reviewers": {
          "description": "The people or teams that may review jobs that reference the environment",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "description": "The type of reviewer (`User` or `Team`)",
                "type": "string"
              },
              "id": {
                "description": "The id of the user or team who can review the deployment",
                "type": "integer"
              }
            }
          }
        },
        "deployment_branch_policy": {
          "description": "The type of deployment branch policy for this environment",
          "type": "object",
          "properties": {
            "protected_branches": {
              "description": "Whether only protected branches can be deployed to this environment",
              "type": "boolean"
            },
            "custom_branch_policies": {
              "description": "Whether only branches that match the specified name patterns can deploy to this environment",
              "type": "boolean"
            }
          }
        },
        "prevent_self_review": {
          "description": "Whether or not a user who created the job is prevented from approving their own job",
          "type": "boolean"
        }
      }
    },
    "CustomPropertiesSettings": {
      "description": "A custom property entry",
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "VariablesSettings": {
      "description": "An Actions variable entry",
      "type": "object",
      "required": ["name", "value"],
      "properties": {
        "name": {
          "description": "The name of the variable",
          "type": "string"
        },
        "value": {
          "description": "The value of the variable",
          "type": "string"
        },
        "visibility": {
          "description": "The visibility of the variable. Can be `all`, `private`, or `selected`",
          "type": "string",
          "enum": ["all", "private", "selected"]
        }
      }
    }
  }
}