Skip to main content

@backstage/plugin-catalog-backend-module-github

Home > @backstage/plugin-catalog-backend-module-github

A Backstage catalog backend module that helps integrate towards Github

Classes

ClassDescription
GithubDiscoveryProcessor

Extracts repositories out of a GitHub org.

The following will create locations for all projects which have a catalog-info.yaml on the default branch. The first is shorthand for the second.

target: "https://github.com/backstage" or target: https://github.com/backstage/\*/blob/-/catalog-info.yaml

You may also explicitly specify the source branch:

target: https://github.com/backstage/\*/blob/main/catalog-info.yaml

GithubEntityProviderDiscovers catalog files located in [GitHub](https://github.com). The provider will search your GitHub account and register catalog files matching the configured path as Location entity and via following processing steps add all contained catalog entities. This can be useful as an alternative to static locations or manually adding things to the catalog.
GitHubEntityProvider
GithubLocationAnalyzer
GithubMultiOrgEntityProviderIngests org data (users and groups) from GitHub.
GithubMultiOrgReaderProcessor

Extracts teams and users out of a multiple GitHub orgs namespaced per org.

Be aware that this processor may not be compatible with future org structures in the catalog.

GithubOrgEntityProviderIngests org data (users and groups) from GitHub.
GitHubOrgEntityProvider
GithubOrgReaderProcessorExtracts teams and users out of a GitHub org.

Interfaces

InterfaceDescription
GithubMultiOrgEntityProviderOptionsOptions for GithubMultiOrgEntityProvider.
GithubOrgEntityProviderOptionsOptions for GithubOrgEntityProvider.
TransformerContextContext passed to Transformers

Variables

VariableDescription
defaultOrganizationTeamTransformerDefault transformer for GitHub Team to GroupEntity
defaultUserTransformerDefault transformer for GitHub users to UserEntity

Type Aliases

Type AliasDescription
GithubLocationAnalyzerOptions
GithubMultiOrgConfigThe configuration parameters for a multi-org GitHub processor.
GitHubOrgEntityProviderOptions
GithubTeamGithub Team
GithubUserGithub User
TeamTransformerTransformer for GitHub Team to an Entity
UserTransformerTransformer for GitHub users to an Entity