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

feat(catalog): add filter to include archived repositories

Browse Source 
Signed-off-by: Benjamin Janssens <benji.janssens@gmail.com>
This commit is contained in:
Benjamin Janssens
2025-05-09 11:47:59 +02:00
parent e0455bdae7
commit ee9f59f3e0
6 changed files with 43 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/old-parents-cut.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-backend-module-github': patch
---
Added filter to include archived repositories
docs/integrations/github/discovery.md
+2
View File
@@ -168,6 +168,8 @@ If you do so, `default` will be used as provider ID.
If configured, all repositories _except_ those with one (or more) topics(s) present in the exclusion filter will be ingested.
- **`visibility`** _(optional)_:
An array of strings used to filter results based on their visibility. Available options are `private`, `internal`, `public`. If configured (non empty), only repositories with visibility present in the filter will be ingested
- **`includeArchived`** _(optional)_:
Whether to include archived repositories. Defaults to `false`.
- **`host`** _(optional)_:
The hostname of your GitHub Enterprise instance. It must match a host defined in [integrations.github](locations.md).
- **`organization`**:
plugins/catalog-backend-module-github/config.d.ts
Vendored
+10
View File
@@ -117,6 +117,11 @@ export interface Config {
* (Optional) GitHub repository visibility filter.
*/
visibility?: Array<'private' | 'internal' | 'public'>;
/**
* (Optional) Whether to include archived repositories.
* Default: `false`.
*/
includeArchived?: boolean;
};
/**
* (Optional) TaskScheduleDefinition for the refresh.
@@ -186,6 +191,11 @@ export interface Config {
* (Optional) GitHub repository visibility filter.
*/
visibility?: Array<'private' | 'internal' | 'public'>;
/**
* (Optional) Whether to include archived repositories.
* Default: `false`.
*/
includeArchived?: boolean;
};
/**
* (Optional) TaskScheduleDefinition for the refresh.
plugins/catalog-backend-module-github/src/providers/GithubEntityProvider.ts
+11 -8
View File
@@ -256,15 +256,16 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber {
}
private matchesFilters(repositories: Repository[]): Repository[] {
const repositoryFilter = this.config.filters?.repository;
const topicFilters = this.config.filters?.topic;
const allowForks = this.config.filters?.allowForks ?? true;
const visibilities = this.config.filters?.visibility ?? [];
const repositoryFilter = this.config.filters.repository;
const topicFilters = this.config.filters.topic;
const allowForks = this.config.filters.allowForks;
const visibilities = this.config.filters.visibility ?? [];
const includeArchived = this.config.filters.includeArchived;
return repositories.filter(r => {
const repoTopics: string[] = r.repositoryTopics;
return (
!r.isArchived &&
(includeArchived || !r.isArchived) &&
(!repositoryFilter || repositoryFilter.test(r.name)) &&
satisfiesTopicFilter(repoTopics, topicFilters) &&
satisfiesForkFilter(allowForks, r.isFork) &&
@@ -276,7 +277,7 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber {
private createLocationUrl(repository: Repository): string {
const branch =
this.config.filters?.branch || repository.defaultBranchRef || '-';
this.config.filters.branch || repository.defaultBranchRef || '-';
const catalogFile = this.config.catalogPath.startsWith('/')
? this.config.catalogPath.substring(1)
: this.config.catalogPath;
@@ -334,7 +335,7 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber {
this.logger.debug(`handle github:push event for ${repoName} - ${repoUrl}`);
const branch =
this.config.filters?.branch || event.repository.default_branch;
this.config.filters.branch || event.repository.default_branch;
if (!event.ref.includes(branch)) {
this.logger.debug(`skipping push event from ref ${event.ref}`);
@@ -468,6 +469,8 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber {
* @param event - The repository archived event.
*/
private async onRepoArchived(event: RepositoryArchivedEvent) {
if (this.config.filters.includeArchived) return;
const repository = this.createRepoFromEvent(event);
await this.removeEntitiesForRepo(repository);
this.logger.debug(
@@ -549,7 +552,7 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber {
*
* Creates new entities for the repository if it matches the filters.
*
* @param event - The repository unarchived event.
* @param event - The repository transferred event.
*/
private async onRepoTransferred(event: RepositoryTransferredEvent) {
const repository = this.createRepoFromEvent(event);
plugins/catalog-backend-module-github/src/providers/GithubEntityProviderConfig.test.ts
+9
View File
@@ -126,6 +126,7 @@ describe('readProviderConfigs', () => {
exclude: undefined,
},
visibility: undefined,
includeArchived: false,
},
schedule: DEFAULT_GITHUB_ENTITY_PROVIDER_CONFIG_SCHEDULE,
validateLocationsExist: false,
@@ -144,6 +145,7 @@ describe('readProviderConfigs', () => {
exclude: undefined,
},
visibility: undefined,
includeArchived: false,
},
schedule: DEFAULT_GITHUB_ENTITY_PROVIDER_CONFIG_SCHEDULE,
validateLocationsExist: false,
@@ -162,6 +164,7 @@ describe('readProviderConfigs', () => {
exclude: undefined,
},
visibility: undefined,
includeArchived: false,
},
schedule: DEFAULT_GITHUB_ENTITY_PROVIDER_CONFIG_SCHEDULE,
validateLocationsExist: false,
@@ -180,6 +183,7 @@ describe('readProviderConfigs', () => {
exclude: undefined,
},
visibility: undefined,
includeArchived: false,
},
schedule: DEFAULT_GITHUB_ENTITY_PROVIDER_CONFIG_SCHEDULE,
validateLocationsExist: false,
@@ -198,6 +202,7 @@ describe('readProviderConfigs', () => {
exclude: ['backstage-exclude'],
},
visibility: undefined,
includeArchived: false,
},
schedule: DEFAULT_GITHUB_ENTITY_PROVIDER_CONFIG_SCHEDULE,
validateLocationsExist: false,
@@ -216,6 +221,7 @@ describe('readProviderConfigs', () => {
exclude: undefined,
},
visibility: undefined,
includeArchived: false,
},
schedule: DEFAULT_GITHUB_ENTITY_PROVIDER_CONFIG_SCHEDULE,
validateLocationsExist: false,
@@ -234,6 +240,7 @@ describe('readProviderConfigs', () => {
exclude: undefined,
},
visibility: ['public', 'internal'],
includeArchived: false,
},
schedule: DEFAULT_GITHUB_ENTITY_PROVIDER_CONFIG_SCHEDULE,
validateLocationsExist: false,
@@ -252,6 +259,7 @@ describe('readProviderConfigs', () => {
exclude: undefined,
},
visibility: undefined,
includeArchived: false,
},
validateLocationsExist: false,
schedule: DEFAULT_GITHUB_ENTITY_PROVIDER_CONFIG_SCHEDULE,
@@ -270,6 +278,7 @@ describe('readProviderConfigs', () => {
exclude: undefined,
},
visibility: undefined,
includeArchived: false,
},
schedule: {
frequency: { minutes: 30 },
plugins/catalog-backend-module-github/src/providers/GithubEntityProviderConfig.ts
+6 -2
View File
@@ -37,12 +37,13 @@ export type GithubEntityProviderConfig = {
catalogPath: string;
organization: string;
host: string;
filters?: {
filters: {
repository?: RegExp;
branch?: string;
topic?: GithubTopicFilters;
allowForks?: boolean;
allowForks: boolean;
visibility?: string[];
includeArchived: boolean;
};
validateLocationsExist: boolean;
schedule?: SchedulerServiceTaskScheduleDefinition;
@@ -90,6 +91,8 @@ function readProviderConfig(
const topicFilterExclude = config?.getOptionalStringArray(
'filters.topic.exclude',
);
const includeArchived =
config.getOptionalBoolean('filters.includeArchived') ?? false;
const validateLocationsExist =
config?.getOptionalBoolean('validateLocationsExist') ?? false;
@@ -132,6 +135,7 @@ function readProviderConfig(
exclude: topicFilterExclude,
},
visibility: visibilityFilterInclude,
includeArchived,
},
schedule,
validateLocationsExist,