Skip to content

spec.scm

Source-control configuration for the generated project - which provider it lives on, and which provider-specific scaffolding (CI, CD, Dependabot, issue templates, …) the generator should set up.

yaml
spec:
  scm:
    provider: github
    url: https://github.com/company/customer-support-agent
    github_app: true
    issue_templates: true
    dependabot: true
    ci: true
    cd: true

Fields

FieldTypeConstraintDescription
providerstringenum: github, gitlab, bitbucketThe SCM provider hosting the repository.
urlstring-Full URL of the repository.
github_appboolean-Generate GitHub App configuration (e.g. permissions, manifest).
issue_templatesboolean-Generate issue templates (bug report, feature request, …).
dependabotboolean-Generate a Dependabot config tracking the project's package ecosystems.
ciboolean-Generate CI workflows (lint, test, build).
cdboolean-Generate CD workflows (release, deploy).

Every field is optional. Omit the block entirely if the generator's defaults work for you, or supply only the toggles you care about.

The github_app and issue_templates flags are most useful with provider: github; consumers may interpret or ignore them when the provider is gitlab or bitbucket.