From 3a7b77697f98b9c8adfbaf5b59905e366ef61a68 Mon Sep 17 00:00:00 2001 From: Julio Zynger Date: Mon, 3 Jan 2022 15:23:38 +0100 Subject: [PATCH] Add public annotations to api-report Signed-off-by: Julio Zynger --- .../components/GoCdBuildsComponent/GoCdBuildsComponent.tsx | 5 +++++ plugins/gocd/src/extensions.ts | 5 +++++ plugins/gocd/src/plugin.ts | 5 +++++ 3 files changed, 15 insertions(+) diff --git a/plugins/gocd/src/components/GoCdBuildsComponent/GoCdBuildsComponent.tsx b/plugins/gocd/src/components/GoCdBuildsComponent/GoCdBuildsComponent.tsx index b7938a30b1..46e5d09260 100644 --- a/plugins/gocd/src/components/GoCdBuildsComponent/GoCdBuildsComponent.tsx +++ b/plugins/gocd/src/components/GoCdBuildsComponent/GoCdBuildsComponent.tsx @@ -37,6 +37,11 @@ import { Item, Select } from '../Select'; */ export const GOCD_PIPELINES_ANNOTATION = 'gocd.org/pipelines'; +/** + * Returns true if GoCD annotation is present in the given entity. + * + * @public + */ export const isGoCdAvailable = (entity: Entity): boolean => Boolean(entity.metadata.annotations?.[GOCD_PIPELINES_ANNOTATION]); diff --git a/plugins/gocd/src/extensions.ts b/plugins/gocd/src/extensions.ts index 8b005a9c38..55624c9d7e 100644 --- a/plugins/gocd/src/extensions.ts +++ b/plugins/gocd/src/extensions.ts @@ -16,6 +16,11 @@ import { gocdPlugin } from './plugin'; import { createComponentExtension } from '@backstage/core-plugin-api'; +/** + * GoCD builds table component. + * + * @public + */ export const EntityGoCdContent = gocdPlugin.provide( createComponentExtension({ name: 'EntityGoCdContent', diff --git a/plugins/gocd/src/plugin.ts b/plugins/gocd/src/plugin.ts index 7bb051edee..01081978f4 100644 --- a/plugins/gocd/src/plugin.ts +++ b/plugins/gocd/src/plugin.ts @@ -26,6 +26,11 @@ export const gocdApiRef = createApiRef({ id: 'plugin.gocd.service', }); +/** + * Plugin definition. + * + * @public + */ export const gocdPlugin = createPlugin({ id: 'gocd', apis: [