Argo CD · Schema

v1alpha1SCMProviderGeneratorGithub

SCMProviderGeneratorGithub defines connection info specific to GitHub.

Continuous DeliveryContainersDeploymentGitOpsKubernetesCNCFOpen Source

Properties

Name	Type	Description
allBranches	boolean	Scan all branches instead of just the default branch.
api	string	The GitHub API URL to talk to. If blank, use https://api.github.com/.
appSecretName	string	AppSecretName is a reference to a GitHub App repo-creds secret.
excludeArchivedRepos	boolean	Exclude repositories that are archived.
organization	string	GitHub org to scan. Required.
tokenRef	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argo-cd/refs/heads/main/json-schema/argo-cd-v1alpha1-scm-provider-generator-github-schema.json",
  "title": "v1alpha1SCMProviderGeneratorGithub",
  "description": "SCMProviderGeneratorGithub defines connection info specific to GitHub.",
  "type": "object",
  "properties": {
    "allBranches": {
      "description": "Scan all branches instead of just the default branch.",
      "type": "boolean"
    },
    "api": {
      "description": "The GitHub API URL to talk to. If blank, use https://api.github.com/.",
      "type": "string"
    },
    "appSecretName": {
      "description": "AppSecretName is a reference to a GitHub App repo-creds secret.",
      "type": "string"
    },
    "excludeArchivedRepos": {
      "description": "Exclude repositories that are archived.",
      "type": "boolean"
    },
    "organization": {
      "description": "GitHub org to scan. Required.",
      "type": "string"
    },
    "tokenRef": {
      "$ref": "#/definitions/v1alpha1SecretRef"
    }
  }
}