Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NBS 1.0] Deprecate isomorphic git class #24605

Merged
merged 2 commits into from
May 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/famous-crabs-laugh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@backstage/backend-common': 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.
5 changes: 5 additions & 0 deletions .changeset/strange-rocks-study.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 3 additions & 3 deletions packages/backend-common/api-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ import { V1PodTemplateSpec } from '@kubernetes/client-node';
import * as winston from 'winston';
import { Writable } from 'stream';

// @public
// @public @deprecated
export type AuthCallbackOptions = {
onAuth: AuthCallback;
logger?: LoggerService;
Expand Down Expand Up @@ -370,7 +370,7 @@ export function getRootLogger(): winston.Logger;
// @public
export function getVoidLogger(): winston.Logger;

// @public
// @public @deprecated
export class Git {
// (undocumented)
add(options: { dir: string; filepath: string }): Promise<void>;
Expand Down Expand Up @@ -818,7 +818,7 @@ export function setRootLogger(newLogger: winston.Logger): void;
// @public @deprecated
export const SingleHostDiscovery: typeof HostDiscovery_2;

// @public
// @public @deprecated
export type StaticAuthOptions = {
username?: string;
password?: string;
Expand Down
17 changes: 17 additions & 0 deletions packages/backend-common/src/deprecated/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/*
* Copyright 2024 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

export * from './scm';