From f633efa1c74365a4e7bb7cabfa48306f7d19e9ea Mon Sep 17 00:00:00 2001 From: Camila Belo Date: Mon, 13 May 2024 10:35:20 +0200 Subject: [PATCH] refactor: apply review suggestions Signed-off-by: Camila Belo --- .changeset/famous-crabs-laugh.md | 1 - .changeset/strange-rocks-study.md | 5 +++++ packages/backend-common/src/reading/GerritUrlReader.ts | 8 +------- packages/backend-common/src/reading/git.ts | 7 ++++++- 4 files changed, 12 insertions(+), 9 deletions(-) create mode 100644 .changeset/strange-rocks-study.md diff --git a/.changeset/famous-crabs-laugh.md b/.changeset/famous-crabs-laugh.md index 6427fbbc82..282cbb9f93 100644 --- a/.changeset/famous-crabs-laugh.md +++ b/.changeset/famous-crabs-laugh.md @@ -1,6 +1,5 @@ --- '@backstage/backend-common': patch -'@backstage/plugin-scaffolder-node': patch --- Preparing for a stable new backend system release, we are deprecating utilities in the `backend-common` that are not used by the core framework, such as the isomorphic `Git` class. As we will no longer support the isomorphic `Git` utility in the framework packages, we recommend plugins that start maintaining their own implementation of this class. diff --git a/.changeset/strange-rocks-study.md b/.changeset/strange-rocks-study.md new file mode 100644 index 0000000000..75ceb745fb --- /dev/null +++ b/.changeset/strange-rocks-study.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-scaffolder-node': patch +--- + +To remove the dependency on the soon-to-be-deprecated `backend-common` package, this package now maintains its own isomorphic Git class implementation. diff --git a/packages/backend-common/src/reading/GerritUrlReader.ts b/packages/backend-common/src/reading/GerritUrlReader.ts index b8a3d98392..52a541382b 100644 --- a/packages/backend-common/src/reading/GerritUrlReader.ts +++ b/packages/backend-common/src/reading/GerritUrlReader.ts @@ -45,13 +45,7 @@ import { SearchResponse, UrlReader, } from './types'; -import { StaticAuthOptions, AuthCallbackOptions, Git } from './git'; - -export function isAuthCallbackOptions( - options: StaticAuthOptions | AuthCallbackOptions, -): options is AuthCallbackOptions { - return 'onAuth' in options; -} +import { Git } from './git'; const pipeline = promisify(pipelineCb); diff --git a/packages/backend-common/src/reading/git.ts b/packages/backend-common/src/reading/git.ts index ecd38d6c0c..119d4f64bd 100644 --- a/packages/backend-common/src/reading/git.ts +++ b/packages/backend-common/src/reading/git.ts @@ -18,7 +18,6 @@ import fs from 'fs-extra'; import isomorphicGit, { ProgressCallback, AuthCallback } from 'isomorphic-git'; import http from 'isomorphic-git/http/node'; import { LoggerService } from '@backstage/backend-plugin-api'; -import { isAuthCallbackOptions } from './GerritUrlReader'; /** * Configure static credential for authentication @@ -42,6 +41,12 @@ export type AuthCallbackOptions = { logger?: LoggerService; }; +function isAuthCallbackOptions( + options: StaticAuthOptions | AuthCallbackOptions, +): options is AuthCallbackOptions { + return 'onAuth' in options; +} + /* provider username password Azure 'notempty' token