GithubDiscoveryProcessor

Home > @backstage/plugin-catalog-backend-module-github > 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

Signature:

class GithubDiscoveryProcessor implements CatalogProcessor 

Implements: CatalogProcessor

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Constructs a new instance of the GithubDiscoveryProcessor class

Methods

Method	Modifiers	Description
fromConfig(config, options)	static
getProcessorName()
readLocation(location, _optional, emit)