From c128e64ce3ad3bf8646f3c3a224d123d73ccbf9c Mon Sep 17 00:00:00 2001 From: Phil Kuang Date: Wed, 12 May 2021 15:06:25 -0400 Subject: [PATCH] revert(integration): remove annotation prefix props Signed-off-by: Phil Kuang --- .changeset/gold-boats-wash.md | 5 ----- packages/integration/api-report.md | 5 ----- .../src/azure/AzureIntegration.test.ts | 1 - .../integration/src/azure/AzureIntegration.ts | 7 ------ .../bitbucket/BitbucketIntegration.test.ts | 1 - .../src/bitbucket/BitbucketIntegration.ts | 7 ------ .../src/github/GitHubIntegration.test.ts | 1 - .../src/github/GitHubIntegration.ts | 7 ------ .../src/gitlab/GitLabIntegration.test.ts | 1 - .../src/gitlab/GitLabIntegration.ts | 7 ------ packages/integration/src/types.ts | 5 ----- .../src/ingestion/LocationAnalyzer.ts | 22 +++++++++++++++++-- 12 files changed, 20 insertions(+), 49 deletions(-) delete mode 100644 .changeset/gold-boats-wash.md diff --git a/.changeset/gold-boats-wash.md b/.changeset/gold-boats-wash.md deleted file mode 100644 index 709df2baf9..0000000000 --- a/.changeset/gold-boats-wash.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@backstage/integration': patch ---- - -Expose an `annotationPrefix` property for SCM integrations diff --git a/packages/integration/api-report.md b/packages/integration/api-report.md index 09d14a5a11..5387eb12db 100644 --- a/packages/integration/api-report.md +++ b/packages/integration/api-report.md @@ -9,7 +9,6 @@ import { Config } from '@backstage/config'; // @public (undocumented) export class AzureIntegration implements ScmIntegration { constructor(integrationConfig: AzureIntegrationConfig); - get annotationPrefix(): string; // (undocumented) get config(): AzureIntegrationConfig; // (undocumented) @@ -37,7 +36,6 @@ export type AzureIntegrationConfig = { // @public (undocumented) export class BitbucketIntegration implements ScmIntegration { constructor(integrationConfig: BitbucketIntegrationConfig); - get annotationPrefix(): string; // (undocumented) get config(): BitbucketIntegrationConfig; // (undocumented) @@ -120,7 +118,6 @@ export class GithubCredentialsProvider { // @public (undocumented) export class GitHubIntegration implements ScmIntegration { constructor(integrationConfig: GitHubIntegrationConfig); - get annotationPrefix(): string; // (undocumented) get config(): GitHubIntegrationConfig; // (undocumented) @@ -151,7 +148,6 @@ export type GitHubIntegrationConfig = { // @public (undocumented) export class GitLabIntegration implements ScmIntegration { constructor(integrationConfig: GitLabIntegrationConfig); - get annotationPrefix(): string; // (undocumented) get config(): GitLabIntegrationConfig; // (undocumented) @@ -213,7 +209,6 @@ export function readGoogleGcsIntegrationConfig(config: Config): GoogleGcsIntegra // @public export interface ScmIntegration { - annotationPrefix: string; resolveEditUrl(url: string): string; resolveUrl(options: { url: string; diff --git a/packages/integration/src/azure/AzureIntegration.test.ts b/packages/integration/src/azure/AzureIntegration.test.ts index a41ee6ac5f..1702602cf3 100644 --- a/packages/integration/src/azure/AzureIntegration.test.ts +++ b/packages/integration/src/azure/AzureIntegration.test.ts @@ -39,7 +39,6 @@ describe('AzureIntegration', () => { it('returns the basics', () => { const integration = new AzureIntegration({ host: 'h.com' } as any); expect(integration.type).toBe('azure'); - expect(integration.annotationPrefix).toBe('dev.azure.com'); expect(integration.title).toBe('h.com'); }); diff --git a/packages/integration/src/azure/AzureIntegration.ts b/packages/integration/src/azure/AzureIntegration.ts index d0f6f54ede..50f4757620 100644 --- a/packages/integration/src/azure/AzureIntegration.ts +++ b/packages/integration/src/azure/AzureIntegration.ts @@ -36,13 +36,6 @@ export class AzureIntegration implements ScmIntegration { return 'azure'; } - /** - * The prefix used for entity metadata.annotations for the integration. - */ - get annotationPrefix(): string { - return 'dev.azure.com'; - } - get title(): string { return this.integrationConfig.host; } diff --git a/packages/integration/src/bitbucket/BitbucketIntegration.test.ts b/packages/integration/src/bitbucket/BitbucketIntegration.test.ts index 27adbd1a8f..350bb1d63c 100644 --- a/packages/integration/src/bitbucket/BitbucketIntegration.test.ts +++ b/packages/integration/src/bitbucket/BitbucketIntegration.test.ts @@ -42,7 +42,6 @@ describe('BitbucketIntegration', () => { it('returns the basics', () => { const integration = new BitbucketIntegration({ host: 'h.com' } as any); expect(integration.type).toBe('bitbucket'); - expect(integration.annotationPrefix).toBe('bitbucket.org'); expect(integration.title).toBe('h.com'); }); diff --git a/packages/integration/src/bitbucket/BitbucketIntegration.ts b/packages/integration/src/bitbucket/BitbucketIntegration.ts index d23a78986a..1e07507bf2 100644 --- a/packages/integration/src/bitbucket/BitbucketIntegration.ts +++ b/packages/integration/src/bitbucket/BitbucketIntegration.ts @@ -41,13 +41,6 @@ export class BitbucketIntegration implements ScmIntegration { return 'bitbucket'; } - /** - * The prefix used for entity metadata.annotations for the integration. - */ - get annotationPrefix(): string { - return 'bitbucket.org'; - } - get title(): string { return this.integrationConfig.host; } diff --git a/packages/integration/src/github/GitHubIntegration.test.ts b/packages/integration/src/github/GitHubIntegration.test.ts index f224a169ce..501ae6c3bf 100644 --- a/packages/integration/src/github/GitHubIntegration.test.ts +++ b/packages/integration/src/github/GitHubIntegration.test.ts @@ -46,7 +46,6 @@ describe('GitHubIntegration', () => { token: 't', }); expect(integration.type).toBe('github'); - expect(integration.annotationPrefix).toBe('github.com'); expect(integration.title).toBe('h.com'); expect(integration.config.host).toBe('h.com'); }); diff --git a/packages/integration/src/github/GitHubIntegration.ts b/packages/integration/src/github/GitHubIntegration.ts index 3b88233cad..d33057b88f 100644 --- a/packages/integration/src/github/GitHubIntegration.ts +++ b/packages/integration/src/github/GitHubIntegration.ts @@ -38,13 +38,6 @@ export class GitHubIntegration implements ScmIntegration { return 'github'; } - /** - * The prefix used for entity metadata.annotations for the integration. - */ - get annotationPrefix(): string { - return 'github.com'; - } - get title(): string { return this.integrationConfig.host; } diff --git a/packages/integration/src/gitlab/GitLabIntegration.test.ts b/packages/integration/src/gitlab/GitLabIntegration.test.ts index e70b6ea094..5cc6d410e3 100644 --- a/packages/integration/src/gitlab/GitLabIntegration.test.ts +++ b/packages/integration/src/gitlab/GitLabIntegration.test.ts @@ -41,7 +41,6 @@ describe('GitLabIntegration', () => { it('returns the basics', () => { const integration = new GitLabIntegration({ host: 'h.com' } as any); expect(integration.type).toBe('gitlab'); - expect(integration.annotationPrefix).toBe('gitlab.com'); expect(integration.title).toBe('h.com'); }); diff --git a/packages/integration/src/gitlab/GitLabIntegration.ts b/packages/integration/src/gitlab/GitLabIntegration.ts index fd356581a5..17fb82f010 100644 --- a/packages/integration/src/gitlab/GitLabIntegration.ts +++ b/packages/integration/src/gitlab/GitLabIntegration.ts @@ -38,13 +38,6 @@ export class GitLabIntegration implements ScmIntegration { return 'gitlab'; } - /** - * The prefix used for entity metadata.annotations for the integration. - */ - get annotationPrefix(): string { - return 'gitlab.com'; - } - get title(): string { return this.integrationConfig.host; } diff --git a/packages/integration/src/types.ts b/packages/integration/src/types.ts index 971b341a8e..f06bda285a 100644 --- a/packages/integration/src/types.ts +++ b/packages/integration/src/types.ts @@ -29,11 +29,6 @@ export interface ScmIntegration { */ type: string; - /** - * The prefix used for entity metadata.annotations for the integration , e.g. "github.com". - */ - annotationPrefix: string; - /** * A human readable title for the integration, that can be shown to users to * differentiate between different integrations. diff --git a/plugins/catalog-backend/src/ingestion/LocationAnalyzer.ts b/plugins/catalog-backend/src/ingestion/LocationAnalyzer.ts index f510bec37e..cacdf38ffd 100644 --- a/plugins/catalog-backend/src/ingestion/LocationAnalyzer.ts +++ b/plugins/catalog-backend/src/ingestion/LocationAnalyzer.ts @@ -46,9 +46,27 @@ export class RepoLocationAnalyzer implements LocationAnalyzer { }; const integration = this.scmIntegrations.byUrl(request.location.target); - if (integration) { + let annotationPrefix; + switch (integration?.type) { + case 'azure': + annotationPrefix = 'dev.azure.com'; + break; + case 'bitbucket': + annotationPrefix = 'bitbucket.org'; + break; + case 'github': + annotationPrefix = 'github.com'; + break; + case 'gitlab': + annotationPrefix = 'gitlab.com'; + break; + default: + break; + } + + if (annotationPrefix) { entity.metadata.annotations = { - [`${integration.annotationPrefix}/project-slug`]: `${owner}/${name}`, + [`${annotationPrefix}/project-slug`]: `${owner}/${name}`, }; }