@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 |
---|---|
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 | |
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. | |
Ingests org data (users and groups) from GitHub. | |
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. | |
Ingests org data (users and groups) from GitHub. | |
Extracts teams and users out of a GitHub org. |
Functions
Function |
Description |
---|---|
Default transformer for GitHub users to UserEntity |
Interfaces
Interface |
Description |
---|---|
Options for GithubMultiOrgEntityProvider. | |
Options for GithubOrgEntityProvider. | |
Context passed to Transformers |
Variables
Variable |
Description |
---|---|
Default transformer for GitHub Team to GroupEntity | |
Registers the |
Type Aliases
Type Alias |
Description |
---|---|
The configuration parameters for a multi-org GitHub processor. | |
Github Team | |
Github User | |
Transformer for GitHub Team to an Entity | |
Transformer for GitHub users to an Entity |