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

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

A Backstage catalog backend module that helps integrate towards Github

Classes

Class	Description
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
GithubEntityProvider	Discovers 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
GithubMultiOrgEntityProvider	Ingests 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.
GithubOrgEntityProvider	Ingests org data (users and groups) from GitHub.
GitHubOrgEntityProvider
GithubOrgReaderProcessor	Extracts teams and users out of a GitHub org.

Functions

Function	Description
defaultUserTransformer(item, _ctx)	Default transformer for GitHub users to UserEntity

Interfaces

Interface	Description
GithubMultiOrgEntityProviderOptions	Options for GithubMultiOrgEntityProvider.
GithubOrgEntityProviderOptions	Options for GithubOrgEntityProvider.
TransformerContext	Context passed to Transformers

Variables

Variable	Description
defaultOrganizationTeamTransformer	Default transformer for GitHub Team to GroupEntity
githubCatalogModule	Registers the GithubEntityProvider with the catalog processing extension point.

Type Aliases

Type Alias	Description
GithubLocationAnalyzerOptions
GithubMultiOrgConfig	The configuration parameters for a multi-org GitHub processor.
GitHubOrgEntityProviderOptions
GithubTeam	Github Team
GithubUser	Github User
TeamTransformer	Transformer for GitHub Team to an Entity
UserTransformer	Transformer for GitHub users to an Entity