Linking code from Gitea

Sourcebot can sync code from Gitea Cloud, and self-hosted.

Examples

Copy
{
    "type": "gitea",
    // Include all repos in my-org...
    "orgs": [
        "my-org"
    ],
    // ...except:
    "exclude": {
        // repos that are archived
        "archived": true,
        // repos that are forks
        "forks": true,
        // repos that match these glob patterns
        "repos": [
            "my-org/repo1",
            "my-org/repo2",
            "my-org/sub-org-1/**",
            "my-org/sub-org-*/**"
        ]
    }
}

Authenticating with Gitea

In order to index private repositories, you’ll need to generate a Gitea access token. Generate a Gitea access token here. At minimum, you’ll need to select the read:repository scope. read:user and read:organization are required for the user and org fields of your config file:

Gitea Access token creation

Next, provide the access token via the token property, either as an environment variable or a secret:

Environment variables are only supported in a declarative config and cannot be used in the web UI.

Add the token property to your connection config:

Copy
{
    "type": "gitea",
    "token": {
        // note: this env var can be named anything. It
        // doesn't need to be `GITEA_TOKEN`.
        "env": "GITEA_TOKEN"
    }
    // .. rest of config ..
}

Pass this environment variable each time you run Sourcebot:

Copy
docker run \
    -e GITEA_TOKEN=<PAT> \
    /* additional args */ \
    ghcr.io/sourcebot-dev/sourcebot:latest

Environment variables are only supported in a declarative config and cannot be used in the web UI.

Add the token property to your connection config:

Copy
{
    "type": "gitea",
    "token": {
        // note: this env var can be named anything. It
        // doesn't need to be `GITEA_TOKEN`.
        "env": "GITEA_TOKEN"
    }
    // .. rest of config ..
}

Pass this environment variable each time you run Sourcebot:

Copy
docker run \
    -e GITEA_TOKEN=<PAT> \
    /* additional args */ \
    ghcr.io/sourcebot-dev/sourcebot:latest

Secrets are only supported when authentication is enabled.

Navigate to Secrets in settings and create a new secret with your PAT:

Add the token property to your connection config:

Copy
{
    "type": "gitea",
    "token": {
        "secret": "mysecret"
    }
    // .. rest of config ..
}

Connecting to a custom Gitea

To connect to a custom Gitea deployment, provide the url property to your config:

Copy
{
    "type": "gitea",
    "url": "https://gitea.example.com"
    // .. rest of config ..
}

Schema reference

schemas/v3/gitea.json

Copy
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "title": "GiteaConnectionConfig",
  "properties": {
    "type": {
      "const": "gitea",
      "description": "Gitea Configuration"
    },
    "token": {
      "description": "A Personal Access Token (PAT).",
      "examples": [
        {
          "secret": "SECRET_KEY"
        }
      ],
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "secret": {
              "type": "string",
              "description": "The name of the secret that contains the token."
            }
          },
          "required": [
            "secret"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "env": {
              "type": "string",
              "description": "The name of the environment variable that contains the token. Only supported in declarative connection configs."
            }
          },
          "required": [
            "env"
          ],
          "additionalProperties": false
        }
      ]
    },
    "url": {
      "type": "string",
      "format": "url",
      "default": "https://gitea.com",
      "description": "The URL of the Gitea host. Defaults to https://gitea.com",
      "examples": [
        "https://gitea.com",
        "https://gitea.example.com"
      ],
      "pattern": "^https?:\\/\\/[^\\s/$.?#].[^\\s]*$"
    },
    "orgs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "examples": [
        [
          "my-org-name"
        ]
      ],
      "description": "List of organizations to sync with. All repositories in the organization visible to the provided `token` (if any) will be synced, unless explicitly defined in the `exclude` property. If a `token` is provided, it must have the read:organization scope."
    },
    "repos": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[\\w.-]+\\/[\\w.-]+$"
      },
      "description": "List of individual repositories to sync with. Expected to be formatted as '{orgName}/{repoName}' or '{userName}/{repoName}'."
    },
    "users": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "examples": [
        [
          "username-1",
          "username-2"
        ]
      ],
      "description": "List of users to sync with. All repositories that the user owns will be synced, unless explicitly defined in the `exclude` property. If a `token` is provided, it must have the read:user scope."
    },
    "exclude": {
      "type": "object",
      "properties": {
        "forks": {
          "type": "boolean",
          "default": false,
          "description": "Exclude forked repositories from syncing."
        },
        "archived": {
          "type": "boolean",
          "default": false,
          "description": "Exclude archived repositories from syncing."
        },
        "repos": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": [],
          "description": "List of individual repositories to exclude from syncing. Glob patterns are supported."
        }
      },
      "additionalProperties": false
    },
    "revisions": {
      "type": "object",
      "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed. A maximum of 64 revisions can be indexed, with any additional revisions being ignored.",
      "properties": {
        "branches": {
          "type": "array",
          "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported. A maximum of 64 branches can be indexed, with any additional branches being ignored.",
          "items": {
            "type": "string"
          },
          "examples": [
            [
              "main",
              "release/*"
            ],
            [
              "**"
            ]
          ],
          "default": []
        },
        "tags": {
          "type": "array",
          "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported. A maximum of 64 tags can be indexed, with any additional tags being ignored.",
          "items": {
            "type": "string"
          },
          "examples": [
            [
              "latest",
              "v2.*.*"
            ],
            [
              "**"
            ]
          ],
          "default": []
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": false
}

General

Connecting your code

More

Linking code from Gitea

Examples

Authenticating with Gitea

Connecting to a custom Gitea

Schema reference

General

Connecting your code

More

​Examples

​Authenticating with Gitea

​Connecting to a custom Gitea

​Schema reference

Examples

Authenticating with Gitea

Connecting to a custom Gitea

Schema reference