From cd819fc01520b95c2d393b33b6509402442288db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Fri, 19 Aug 2022 12:01:23 +0200 Subject: [PATCH] tech-radar MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- plugins/tech-radar/api-report.md | 30 ------------------- plugins/tech-radar/src/api.ts | 17 +++++++++++ .../src/components/RadarComponent.tsx | 4 +++ .../tech-radar/src/components/RadarPage.tsx | 4 +++ plugins/tech-radar/src/index.ts | 2 ++ plugins/tech-radar/src/plugin.ts | 5 +++- scripts/api-extractor.ts | 1 - 7 files changed, 31 insertions(+), 32 deletions(-) diff --git a/plugins/tech-radar/api-report.md b/plugins/tech-radar/api-report.md index a55cf79f28..39fa19da43 100644 --- a/plugins/tech-radar/api-report.md +++ b/plugins/tech-radar/api-report.md @@ -9,8 +9,6 @@ import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { RouteRef } from '@backstage/core-plugin-api'; -// Warning: (ae-missing-release-tag) "MovedState" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export enum MovedState { Down = -1, @@ -18,8 +16,6 @@ export enum MovedState { Up = 1, } -// Warning: (ae-missing-release-tag) "RadarEntry" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export interface RadarEntry { description?: string; @@ -31,8 +27,6 @@ export interface RadarEntry { url: string; } -// Warning: (ae-missing-release-tag) "RadarEntrySnapshot" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export interface RadarEntrySnapshot { date: Date; @@ -41,21 +35,15 @@ export interface RadarEntrySnapshot { ringId: string; } -// Warning: (ae-missing-release-tag) "RadarPage" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export function RadarPage(props: TechRadarPageProps): JSX.Element; -// Warning: (ae-missing-release-tag) "RadarQuadrant" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export interface RadarQuadrant { id: string; name: string; } -// Warning: (ae-missing-release-tag) "RadarRing" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export interface RadarRing { color: string; @@ -63,30 +51,20 @@ export interface RadarRing { name: string; } -// Warning: (ae-missing-release-tag) "Router" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public @deprecated (undocumented) export const Router: typeof RadarPage; -// Warning: (ae-missing-release-tag) "TechRadarApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export interface TechRadarApi { load: (id: string | undefined) => Promise; } -// Warning: (ae-missing-release-tag) "techRadarApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export const techRadarApiRef: ApiRef; -// Warning: (ae-missing-release-tag) "RadarComponent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export function TechRadarComponent(props: TechRadarComponentProps): JSX.Element; -// Warning: (ae-missing-release-tag) "TechRadarComponentProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export interface TechRadarComponentProps { height: number; @@ -96,8 +74,6 @@ export interface TechRadarComponentProps { width: number; } -// Warning: (ae-missing-release-tag) "TechRadarLoaderResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export interface TechRadarLoaderResponse { entries: RadarEntry[]; @@ -105,13 +81,9 @@ export interface TechRadarLoaderResponse { rings: RadarRing[]; } -// Warning: (ae-missing-release-tag) "TechRadarPage" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export const TechRadarPage: RadarPage; -// Warning: (ae-missing-release-tag) "TechRadarPageProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export interface TechRadarPageProps extends TechRadarComponentProps { pageTitle?: string; @@ -119,8 +91,6 @@ export interface TechRadarPageProps extends TechRadarComponentProps { title?: string; } -// Warning: (ae-missing-release-tag) "techRadarPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public const techRadarPlugin: BackstagePlugin< { diff --git a/plugins/tech-radar/src/api.ts b/plugins/tech-radar/src/api.ts index 241f3dce85..c932ec98e2 100644 --- a/plugins/tech-radar/src/api.ts +++ b/plugins/tech-radar/src/api.ts @@ -13,10 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + import { ApiRef, createApiRef } from '@backstage/core-plugin-api'; /** * {@link @backstage/core-plugin-api#ApiRef} for the {@link TechRadarApi} + * + * @public */ export const techRadarApiRef: ApiRef = createApiRef( { @@ -31,6 +34,8 @@ export const techRadarApiRef: ApiRef = createApiRef( * * This should be implemented by user, as {@link https://github.com/backstage/backstage/blob/master/plugins/tech-radar/src/sample.ts | default} * serves only some static data for example purposes + * + * @public */ export interface TechRadarApi { /** @@ -46,6 +51,8 @@ export interface TechRadarApi { /** * Tech Radar Ring which indicates stage of {@link RadarEntry} + * + * @public */ export interface RadarRing { /** @@ -68,6 +75,8 @@ export interface RadarRing { /** * Tech Radar Quadrant which represent area/topic of {@link RadarEntry} + * + * @public */ export interface RadarQuadrant { /** @@ -82,6 +91,8 @@ export interface RadarQuadrant { /** * Single Entry in Tech Radar + * + * @public */ export interface RadarEntry { /** @@ -120,6 +131,8 @@ export interface RadarEntry { /** * State of {@link RadarEntry} at given point in time + * + * @public */ export interface RadarEntrySnapshot { /** @@ -142,6 +155,8 @@ export interface RadarEntrySnapshot { /** * Indicates how {@link RadarEntry} moved though {@link RadarRing} on {@link RadarEntry.timeline} + * + * @public */ export enum MovedState { /** @@ -164,6 +179,8 @@ export enum MovedState { /** * Response from {@link TechRadarApi} + * + * @public */ export interface TechRadarLoaderResponse { /** diff --git a/plugins/tech-radar/src/components/RadarComponent.tsx b/plugins/tech-radar/src/components/RadarComponent.tsx index e7cca7d45f..4ed7626d52 100644 --- a/plugins/tech-radar/src/components/RadarComponent.tsx +++ b/plugins/tech-radar/src/components/RadarComponent.tsx @@ -61,6 +61,8 @@ function matchFilter(filter?: string): (entry: RadarEntry) => boolean { /** * Properties of {@link TechRadarComponent} + * + * @public */ export interface TechRadarComponentProps { /** @@ -95,6 +97,8 @@ export interface TechRadarComponentProps { * @remarks * * For advanced use cases. Typically, you want to use {@link TechRadarPage} + * + * @public */ export function RadarComponent(props: TechRadarComponentProps) { const { loading, error, value: data } = useTechRadarLoader(props.id); diff --git a/plugins/tech-radar/src/components/RadarPage.tsx b/plugins/tech-radar/src/components/RadarPage.tsx index 17e481fcc4..49f856eddd 100644 --- a/plugins/tech-radar/src/components/RadarPage.tsx +++ b/plugins/tech-radar/src/components/RadarPage.tsx @@ -34,6 +34,8 @@ const useStyles = makeStyles(() => ({ /** * Properties for {@link TechRadarPage} + * + * @public */ export interface TechRadarPageProps extends TechRadarComponentProps { /** @@ -52,6 +54,8 @@ export interface TechRadarPageProps extends TechRadarComponentProps { /** * Main Page of Tech Radar + * + * @public */ export function RadarPage(props: TechRadarPageProps) { const { diff --git a/plugins/tech-radar/src/index.ts b/plugins/tech-radar/src/index.ts index dbffcca553..0ea02cabe5 100644 --- a/plugins/tech-radar/src/index.ts +++ b/plugins/tech-radar/src/index.ts @@ -32,6 +32,8 @@ export * from './components'; /** * @deprecated Use plugin extensions instead + * + * @public */ export const Router = RadarPage; diff --git a/plugins/tech-radar/src/plugin.ts b/plugins/tech-radar/src/plugin.ts index 495aa47879..7f042a1b6f 100644 --- a/plugins/tech-radar/src/plugin.ts +++ b/plugins/tech-radar/src/plugin.ts @@ -15,7 +15,6 @@ */ import { techRadarApiRef } from './api'; - import { SampleTechRadarApi } from './sample'; import { createPlugin, @@ -30,6 +29,8 @@ const rootRouteRef = createRouteRef({ /** * Tech Radar plugin instance + * + * @public */ export const techRadarPlugin = createPlugin({ id: 'tech-radar', @@ -45,6 +46,8 @@ export const techRadarPlugin = createPlugin({ * @remarks * * Uses {@link TechRadarPageProps} as props + * + * @public */ export const TechRadarPage = techRadarPlugin.provide( createRoutableExtension({ diff --git a/scripts/api-extractor.ts b/scripts/api-extractor.ts index 13c252a991..80ed5d5130 100644 --- a/scripts/api-extractor.ts +++ b/scripts/api-extractor.ts @@ -233,7 +233,6 @@ const ALLOW_WARNINGS = [ 'plugins/pagerduty', 'plugins/search-backend-module-pg', 'plugins/splunk-on-call', - 'plugins/tech-radar', 'plugins/user-settings', ];