From 0f3520d4999400a68d1c5bd1a7a85a25b0cbace1 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Mon, 14 Mar 2022 10:49:47 +0100 Subject: [PATCH] catalog-react: remove deprecated formatEntityRefTitle Signed-off-by: Patrik Oldsberg --- .changeset/tricky-months-sort.md | 5 +++++ plugins/catalog-react/api-report.md | 3 --- .../src/components/EntityRefLink/humanize.test.ts | 2 +- .../catalog-react/src/components/EntityRefLink/humanize.ts | 3 --- plugins/catalog-react/src/components/EntityRefLink/index.ts | 2 +- 5 files changed, 7 insertions(+), 8 deletions(-) create mode 100644 .changeset/tricky-months-sort.md diff --git a/.changeset/tricky-months-sort.md b/.changeset/tricky-months-sort.md new file mode 100644 index 0000000000..43956932f7 --- /dev/null +++ b/.changeset/tricky-months-sort.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-react': minor +--- + +**BREAKING**: Removed the deprecated `formatEntityRefTitle`, use `humanizeEntityRef` instead. diff --git a/plugins/catalog-react/api-report.md b/plugins/catalog-react/api-report.md index 4912c857cf..8b5e10911b 100644 --- a/plugins/catalog-react/api-report.md +++ b/plugins/catalog-react/api-report.md @@ -401,9 +401,6 @@ export const favoriteEntityTooltip: ( isStarred: boolean, ) => 'Remove from favorites' | 'Add to favorites'; -// @public @deprecated (undocumented) -export const formatEntityRefTitle: typeof humanizeEntityRef; - // @public @deprecated (undocumented) export function getEntityMetadataEditUrl(entity: Entity): string | undefined; diff --git a/plugins/catalog-react/src/components/EntityRefLink/humanize.test.ts b/plugins/catalog-react/src/components/EntityRefLink/humanize.test.ts index b541946ece..d41d3c6635 100644 --- a/plugins/catalog-react/src/components/EntityRefLink/humanize.test.ts +++ b/plugins/catalog-react/src/components/EntityRefLink/humanize.test.ts @@ -16,7 +16,7 @@ import { humanizeEntityRef } from './humanize'; -describe('formatEntityRefTitle', () => { +describe('humanizeEntityRef', () => { it('formats entity in default namespace', () => { const entity = { apiVersion: 'v1', diff --git a/plugins/catalog-react/src/components/EntityRefLink/humanize.ts b/plugins/catalog-react/src/components/EntityRefLink/humanize.ts index 0ade1da0b9..2f72a7ee3b 100644 --- a/plugins/catalog-react/src/components/EntityRefLink/humanize.ts +++ b/plugins/catalog-react/src/components/EntityRefLink/humanize.ts @@ -20,9 +20,6 @@ import { DEFAULT_NAMESPACE, } from '@backstage/catalog-model'; -/** @public @deprecated please use {@link humanizeEntityRef} instead */ -export const formatEntityRefTitle = humanizeEntityRef; - /** @public */ export function humanizeEntityRef( entityRef: Entity | CompoundEntityRef, diff --git a/plugins/catalog-react/src/components/EntityRefLink/index.ts b/plugins/catalog-react/src/components/EntityRefLink/index.ts index 50394547a0..50ac3d4534 100644 --- a/plugins/catalog-react/src/components/EntityRefLink/index.ts +++ b/plugins/catalog-react/src/components/EntityRefLink/index.ts @@ -18,4 +18,4 @@ export { EntityRefLink } from './EntityRefLink'; export type { EntityRefLinkProps } from './EntityRefLink'; export { EntityRefLinks } from './EntityRefLinks'; export type { EntityRefLinksProps } from './EntityRefLinks'; -export { humanizeEntityRef, formatEntityRefTitle } from './humanize'; +export { humanizeEntityRef } from './humanize';