repo.schema.yaml

type: object
description: JSONSchema for repo.yaml configuration file
required: [ name, description, type, codeowners ]
additionalProperties: false
properties:
  $meta:
    type: object
    description: Repo-specific metadata

  name:
    type: string
    description: The git repository name.
    pattern: ^[a-z0-9-]+$
    minLength: 1
    maxLength: 50

  description:
    type: string
    description: >
      Repository description that shows up in the sidebar on GitHub, and as the first line of the README after the
      repository name.
    minLength: 1
    maxLength: 100

  type:
    type: string
    description: >
      Classification of repository type. Influences what additional files repo-ansible will generate when
      run.<br>The last 3 listed types have been deprecated and should not be used on new projects.
    enum:
      - php-web
      - php-library
      - php-cli
      - nodejs-web
      - nodejs-library
      - nodejs-cli
      - other
      # DEPRECATED enums
      - application
      - library
      - symfony-bundle

  codeowners:
    type: array
    description: >
      Each array item contains a file/directory pattern and an array of individuals or teams responsible for reviewing
      and maintaining files/directories that match the specified pattern. For a list of allowed patterns, refer to
      [CODEOWNERS syntax](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
    items:
      type: object
      properties:
        pattern:
          type: string
          description: >
            Define patterns that match files or directories within your repository. These patterns can use wildcard
            characters (e.g., * for any characters) to match multiple files or directories. Ensure to enclose patterns
            containing asterisks in quotation marks, e.g. '/docs/*'. A single asterisk '*' indicates default owners for
            everything in the repo.
        owners:
          type: array
          description: >
            A list of individuals or teams responsible for reviewing and maintaining files/directories matching the
            specified pattern. For GitHub usernames, add an @ symbol before the username and enclose the entire pattern
            in quotation marks, e.g. '@joostfaassen'.
          items:
            type: string

  license:
    type: string
    description: Repository license
    default: proprietary
    enum:
    - mit
    - gpl-v3
    - proprietary

  license_year:
    type: number
    description: >
      Year when the license was applied to the repository. Used with the MIT license, as it includes the year as part
      of the generated LICENSE file. Defaults to current year if not set.

  visibility:
    type: string
    description: GitHub repository visibility.
    default: private
    enum:
      - public
      - private

  lifecycle:
    type: string
    description: Project lifecycle stage.
    enum:
      - dev-research
      - dev-prod-bound
      - dev-prod
      - dev-maintenance
      - deprecated-prod
      - archived

  user_scope:
    type: array
    description: Additional project classification in terms of users served.
    items:
      type: string
      enum:
        - external-customer-facing-app
        - internal-team-facing-app
        - enables-external-customer-facing-apps
        - enables-internal-team-facing-apps
        - internal-devops-tooling

  github:
    type: object
    description: GitHub specific values
    additionalProperties: false
    properties:
      topics:
        type: array
        description: GitHub topics. An array of strings.
        items:
          type: string

      default_branch:
        type: string
        default: main
        description: >
          Default branch configuration in GitHub (default main). Override for older repositories that still use master
          branch. Consider updating your repository to include a main branch and remove this option.

      workflows:
        type: object
        description: GitHub workflows for various parts of the software development lifecycle.
        additionalProperties: false
        properties:
          review:
            type: boolean
            default: true
            description: >
              The review workflow will trigger for pull requests and will check if the commit messages conform with
              conventional commits, and if cards are referenced as part of the commit message.

      features:
        type: object
        description: GitHub features
        additionalProperties: false
        properties:
          dependabot_auto_merge:
            description: >
              Generate workflow that automatically merges Dependabot PRs for patch and minor version releases.<br>
              *Note that merging the PR won't automatically trigger other followup workflows.*
            type: boolean
            default: true

          downloads:
            description: Enable repository downloads.
            type: boolean
            default: true
          squash_merge:
            description: Allow squash-merging pull requests.
            type: boolean
            default: true
          merge_commit:
            description: Allow merging pull requests with merge commit.
            type: boolean
            default: true
          rebase_merge:
            description: Allow rebase-merging pull requests.
            type: boolean
            default: true

          sdlc_workflows:
            description: >
              **EXPERIMENTAL** Software Development Lifecycle Workflows. Property will likely be removed in
              the future, and enabled by default, when workflows have been stabilized.
            type: boolean
            default: false

          wiki:
            description: Enable Wiki tab.
            type: boolean
            default: false
          issues:
            description: Enable issues tab.
            type: boolean
            default: false
          projects:
            description: Enable projects tab.
            type: boolean
            default: false

  php:
    type: object
    description: PHP specific values
  docker:
    type: object
    description: Docker specific values

  devcontainer:
    additionalProperties: false
    type: object
    description: Devcontainer specific values
    properties:
      custom_docker_compose_yaml:
        type: boolean
        default: false
        description: >
          When enabled no pre-defined .devcontainer/docker-compose.yaml file will be generated, and instead the
          devcontainer will attempt to use a docker-compose.yaml file located in the root of the repository.
      postCreateCommand:
        description: >
          Additional (shell) commands to run when the containers is created. For a typical project you would specify
          commands that only need to run once when the project is setup. For example you might add a command in here to
          load database fixtures for your project.
        type: string
      postStartCommand:
        description: >
          Additional (shell) commands to run when the container is started. This event takes place after the create
          event, but opposed to the create event it's triggered every time the container is started (including when
          it's resumed from a suspended state). In a typical JavaScript application you might set it to run a
          `npm run dev` or equivalent step.
        type: string

      customizations_vscode:
        type: object
        additionalProperties: false
        default: {}
        description: >
          Customizations done in this group will be merged with the default values configured in
          [group_vars/all.yaml](group_vars/all.yaml)
        properties:
          extensions:
            type: array
            description: >
              Additional extensions to install. Refer to the [group_vars/all.yaml](group_vars/all.yaml) file for
              extensions installed by default.
          settings:
            type: object
            description: >
              Settings overrides for VSCode and installed extensions. Refer to the
              [group_vars/all.yaml](group_vars/all.yaml) file regarding proper format and default values.

      private_packagist:
        type: boolean
        default: true
        description: >
          Repository requires private packagist access. Property is ignored is not of type php-*, or the
          other (deprecated) types: application, library, symfony-bundle.

      repository:
        type: string
        description: Image to use for devcontainer (registry image URL)
        default: ghcr.io/linkorb/php-docker-base
      tag:
        description: Image tag
        type: string
        default: php8-review

  helm_charts:
    type: boolean
    default: false
    description: Enable generation of Helm charts.

  phpqa:
    type: object
    description: phpqa tools specific values
    additionalProperties: false
    properties:
      phpstan:
        type: object
        properties:
          level:
            type: number
            description: phpstan level
            default: 0
          path:
            type: array
            description: Path to directories for phpstan
            default:
              - src
      php_cs_fixer:
        type: object
        properties:
          paths:
            type: array
            description: Paths to included directories
            default:
              - src
          paths_exclude:
            type: array
            description: Paths to excluded directories
            default: []
      composer_unused:
        type: object
        properties:
          filtered_packages:
            type: array
            description: List of project specific packages that should be ignored by composer-unused (PHP regex)
          default_filtered_packages:
            type: array
            default:
              - /^ext-.*/
  security:
    type: object
    additionalProperties: false
    properties:
      email:
        type: string
        default: security@linkorb.com
        description: e-mail address for reporting security issues
      pgp-url:
        type: string
        default: https://engineering.linkorb.com/pgp-key

  archived:
    type: boolean
    default: false
    description: >
      Setting this option to `true` will cause the repository to be archived. Once archived, it can only be unarchived
      manually.

  website:
    type: string
    description: URL with more information about of this repository
    default: https://engineering.linkorb.com

  readme:
    type: object
    additionalProperties: false
    properties:
      enable_generation:
        type: boolean
        default: true
        description: README.md file generation (enabled by default)
      about:
        $ref: "#/definitions/section"
      intro:
        $ref: "#/definitions/section"
      installation:
        $ref: "#/definitions/section"
      configuration:
        $ref: "#/definitions/section"
      usage:
        $ref: "#/definitions/section"
      enabled:
        type: boolean
        default: true
definitions:
  section:
    type: object
    properties:
      title:
        type: string
      content:
        type: string
      after:
        type: string
      before:
        type: string