# bot in charge of keeping dependencies up to date
bot: dependabot | renovate

# project's CI (optional)
# providing it will create the appropriate ci files (.gitlab-ci.yml, .github/actions, .github/workflows)
ci:
  # auth configurations for various features in CI
  auth:
    # maintenance auth strategy for the specified maintenance bot (just above)
    maintenance: github-app | github-token | personal-token

    # release auth for github only (how should the release token be retrieved)
    # will stay empty when using gitlab CICD
    release: github-app | github-token | personal-token

  docker:
    # target path for docker push (i.e. kilianpaquier/craft)
    # (optional, by default will be provisionned with <owner>/<repository>)
    path: kilianpaquier/craft
    # specific exposed port (optional, default is 3000)
    # used in various places like helm values.yml service port
    # Dockerfile exposed port
    port: 3000
    # specific docker registry to push images on
    # (optional, by default the CI platform decides, both GitHub and GitLab CI/CD points to their own registry)
    # used in various places like helm values.yml images registry
    # github release workflow to push images
    registry: ghcr.io

  deployment:
    # deployment automatisation on default branch
    auto: true | false
    # deployment platform name
    platform: kubernetes | netlify | pages

  helm:
    # target path for helm cm-push (i.e. kilianpaquier/craft)
    # (optional, by default will be provisionned with <owner>/<repository>)
    path: kilianpaquier/craft
    # whether to push the project helm chart on an helm repository or not
    publish: auto | manual | none
    # specific helm repository to push the generated chart on
    # (optional, by default the CI platform decides, both GitHub and GitLab CI/CD points to their own registry)
    # OCI based repositories can be used
    registry: (oci://)?ghcr.io

  # ci name - self-explaining what each value will generate - (required when ci section is given)
  name: github | gitlab

  # ci global options, providing one or multiple options with tune the ci generation (optional)
  options:
    - codecov
    - codeql
    - labeler
    - pre-commit:auto-commit
    - sonar

  # release specific options
  release:
    # whether the release should run automatically
    auto: true | false
    # whether backmerging should be configured for main, staging and develop branches
    backmerge: true | false

# project's description (optional)
# used in various places like helm Chart.yml description
# Dockerfile description label
description: some useful description

# list of parts to not generate.
exclude:
  - goreleaser
  - makefile
  - pre-commit
  - shell

# list of optional parts to generate.
include:
  - pre-commit:gomod-tidy
  - renovate:post-upgrade

# project's license (optional)
# providing it will download the appropriate license
# used in various places like goreleaser executables license
# github release workflow license addition to releases
license: agpl-3.0 | apache-2.0 | bsd-2-clause | bsd-3-clause | bsl-1.0 | cc0-1.0 | epl-2.0 | gpl-2.0 | gpl-3.0 | lgpl-2.1 | mit | mpl-2.0 | unlicense

# project's maintainers (at least one must be provided)
# the first maintainer will be referenced in various places like in goreleaser configuration
# Dockerfile maintainer / authors label
# sonar.properties organization and project key prefix
# helm values.yml for images owner (e.g ghcr.io/maintainer/app_name)
# all maintainers will be referenced in dependabot assignees and reviewers
# helm Chart.yml maintainers
maintainers:
  - name: maintainer
    email: [email protected]
    url: maintainer.example.com

# platform override in case of gitlab on premise, bitbucket on premise, etc.
# by default, an on premise gitlab will be matched if the host contains "gitlab"
# by default, an on premise bitbucket will be matched if the host contains "bitbucket" or "stash"
# when not overridden, the platform is matched based on "git config --get remote.origin.url" on the returned host (github.com, gitlab.com, ...)
platform: bitbucket | gitea | github | gitlab