paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 18 Packages Projects Releases Wiki Activity

fix(catalog/github): add missing provider config schema

Browse Source 
Signed-off-by: Patrick Jungermann <Patrick.Jungermann@gmail.com>
This commit is contained in:
Patrick Jungermann
2022-10-07 13:12:48 +02:00
parent 5c44ca2b94
commit 7edb5909e8
3 changed files with 123 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/purple-masks-travel.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-backend-module-github': patch
---
Add missing config schema for the `GitHubEntityProvider`.
docs/integrations/github/discovery.md
+4 -4
View File
@@ -12,7 +12,7 @@ The GitHub integration has a discovery provider for discovering catalog
entities within a GitHub organization. The provider will crawl the GitHub
organization and register entities matching the configured path. This can be
useful as an alternative to static locations or manually adding things to the
catalog. This is the prefered method for ingesting entities into the catalog.
catalog. This is the preferred method for ingesting entities into the catalog.
## Installation
@@ -55,7 +55,7 @@ And then add the entity provider to your catalog builder:
To use the discovery provider, you'll need a GitHub integration
[set up](locations.md) with either a [Personal Access Token](../../getting-started/configuration.md#setting-up-a-github-integration) or [GitHub Apps](./github-apps.md).
Then you can add a github config to the catalog providers configuration:
Then you can add a `github` config to the catalog providers configuration:
```yaml
catalog:
@@ -121,10 +121,10 @@ This provider supports multiple organizations via unique provider IDs.
In the example above, a repository with the `backstage-include` topic would still be excluded
if it were also carrying the `experiments` topic.
- **include** _(optional)_:
An array of strings used to filter in results based on their associated Github topics.
An array of strings used to filter in results based on their associated GitHub topics.
If configured, only repositories with one (or more) topic(s) present in the inclusion filter will be ingested
- **exclude** _(optional)_:
An array of strings used to filter out results based on their associated Github topics.
An array of strings used to filter out results based on their associated GitHub topics.
If configured, all repositories _except_ those with one (or more) topics(s) present in the exclusion filter will be ingested.
- **organization**:
Name of your organization account/workspace.
plugins/catalog-backend-module-github/config.d.ts
Vendored
+114
View File
@@ -45,5 +45,119 @@ export interface Config {
}>;
};
};
providers?: {
/**
* GitHubEntityProvider configuration
*
* Uses "default" as default id for the single config variant.
*/
github?:
| {
/**
* (Optional) The hostname of your GitHub Enterprise instance.
* Default: `github.com`.
*/
host?: string;
/**
* (Required) Name of your organization account/workspace.
*/
organization: string;
/**
* (Optional) Path where to look for `catalog-info.yaml` files.
* You can use wildcards - `*` or `**` - to search the path and/or the filename
* Default: `/catalog-info.yaml`.
*/
catalogPath?: string;
/**
* (Optional) Filter configuration.
*/
filters?: {
/**
* (Optional) String used to filter results based on the branch name.
*/
branch?: string;
/**
* (Optional) Regular expression used to filter results based on the repository name.
*/
repository?: string;
/**
* (Optional) GitHub topic-based filters.
*/
topic?: {
/**
* (Optional) An array of strings used to filter in results based on their associated GitHub topics.
* If configured, only repositories with one (or more) topic(s) present in the inclusion
* filter will be ingested.
*
* If `include` and `exclude` are used, `exclude` has higher priority.
*/
include?: string[];
/**
* (Optional) An array of strings used to filter out results based on their associated GitHub topics.
* If configured, all repositories _except_ those with one (or more) topics(s) present in
* the exclusion filter will be ingested.
*
* If `include` and `exclude` are used, `exclude` has higher priority.
*/
exclude?: string[];
};
};
}
| Record<
string,
{
/**
* (Optional) The hostname of your GitHub Enterprise instance.
* Default: `github.com`.
*/
host?: string;
/**
* (Required) Name of your organization account/workspace.
*/
organization: string;
/**
* (Optional) Path where to look for `catalog-info.yaml` files.
* You can use wildcards - `*` or `**` - to search the path and/or the filename
* Default: `/catalog-info.yaml`.
*/
catalogPath?: string;
/**
* (Optional) Filter configuration.
*/
filters?: {
/**
* (Optional) String used to filter results based on the branch name.
*/
branch?: string;
/**
* (Optional) Regular expression used to filter results based on the repository name.
*/
repository?: string;
/**
* (Optional) GitHub topic-based filters.
*/
topic?: {
/**
* (Optional) An array of strings used to filter in results based on their associated GitHub topics.
* If configured, only repositories with one (or more) topic(s) present in the inclusion
* filter will be ingested.
*
* If `include` and `exclude` are used, `exclude` has higher priority.
*/
include?: string[];
/**
* (Optional) An array of strings used to filter out results based on their associated GitHub topics.
* If configured, all repositories _except_ those with one (or more) topics(s) present in
* the exclusion filter will be ingested.
*
* If `include` and `exclude` are used, `exclude` has higher priority.
*/
exclude?: string[];
};
};
}
>;
};
};
}