diff --git a/plugins/allure/api-report.md b/plugins/allure/api-report.md index e6f5d2aa67..c1ce499ab2 100644 --- a/plugins/allure/api-report.md +++ b/plugins/allure/api-report.md @@ -9,13 +9,9 @@ import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; import { RouteRef } from '@backstage/core-plugin-api'; -// Warning: (ae-missing-release-tag) "ALLURE_PROJECT_ID_ANNOTATION" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const ALLURE_PROJECT_ID_ANNOTATION = 'qameta.io/allure-project'; -// Warning: (ae-missing-release-tag) "allurePlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const allurePlugin: BackstagePlugin< { @@ -25,13 +21,9 @@ export const allurePlugin: BackstagePlugin< {} >; -// Warning: (ae-missing-release-tag) "EntityAllureReportContent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const EntityAllureReportContent: () => JSX.Element; -// Warning: (ae-missing-release-tag) "isAllureReportAvailable" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const isAllureReportAvailable: (entity: Entity) => boolean; ``` diff --git a/plugins/allure/src/components/annotationHelpers.ts b/plugins/allure/src/components/annotationHelpers.ts index 7500c1d88b..21b1a8161d 100644 --- a/plugins/allure/src/components/annotationHelpers.ts +++ b/plugins/allure/src/components/annotationHelpers.ts @@ -15,8 +15,10 @@ */ import { Entity } from '@backstage/catalog-model'; +/** @public */ export const ALLURE_PROJECT_ID_ANNOTATION = 'qameta.io/allure-project'; +/** @public */ export const isAllureReportAvailable = (entity: Entity) => Boolean(entity.metadata.annotations?.[ALLURE_PROJECT_ID_ANNOTATION]); diff --git a/plugins/allure/src/plugin.ts b/plugins/allure/src/plugin.ts index a2eaa06a38..a6cfb25c88 100644 --- a/plugins/allure/src/plugin.ts +++ b/plugins/allure/src/plugin.ts @@ -26,6 +26,7 @@ export const allureRouteRef = createRouteRef({ id: 'allure', }); +/** @public */ export const allurePlugin = createPlugin({ id: 'allure', apis: [ @@ -42,6 +43,7 @@ export const allurePlugin = createPlugin({ }, }); +/** @public */ export const EntityAllureReportContent = allurePlugin.provide( createRoutableExtension({ name: 'EntityAllureReportContent', diff --git a/plugins/bitrise/api-report.md b/plugins/bitrise/api-report.md index f8421a532a..01d10c61cf 100644 --- a/plugins/bitrise/api-report.md +++ b/plugins/bitrise/api-report.md @@ -8,18 +8,15 @@ import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; -// Warning: (ae-missing-release-tag) "bitrisePlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// +// @public (undocumented) +export const BITRISE_APP_ANNOTATION = 'bitrise.io/app'; + // @public (undocumented) export const bitrisePlugin: BackstagePlugin<{}, {}, {}>; -// Warning: (ae-missing-release-tag) "EntityBitriseContent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const EntityBitriseContent: () => JSX.Element; -// Warning: (ae-missing-release-tag) "isBitriseAvailable" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const isBitriseAvailable: (entity: Entity) => boolean; ``` diff --git a/plugins/bitrise/src/components/BitriseBuildsComponent/BitriseBuildsComponent.tsx b/plugins/bitrise/src/components/BitriseBuildsComponent/BitriseBuildsComponent.tsx index f805f050fa..3c93fb20d7 100644 --- a/plugins/bitrise/src/components/BitriseBuildsComponent/BitriseBuildsComponent.tsx +++ b/plugins/bitrise/src/components/BitriseBuildsComponent/BitriseBuildsComponent.tsx @@ -32,8 +32,10 @@ export type Props = { entity: Entity; }; +/** @public */ export const BITRISE_APP_ANNOTATION = 'bitrise.io/app'; +/** @public */ export const isBitriseAvailable = (entity: Entity) => Boolean(entity.metadata.annotations?.[BITRISE_APP_ANNOTATION]); diff --git a/plugins/bitrise/src/extensions.ts b/plugins/bitrise/src/extensions.ts index ccb5fb24dd..e588f092d8 100644 --- a/plugins/bitrise/src/extensions.ts +++ b/plugins/bitrise/src/extensions.ts @@ -17,6 +17,7 @@ import { bitrisePlugin } from './plugin'; import { createComponentExtension } from '@backstage/core-plugin-api'; +/** @public */ export const EntityBitriseContent = bitrisePlugin.provide( createComponentExtension({ name: 'EntityBitriseContent', diff --git a/plugins/bitrise/src/index.ts b/plugins/bitrise/src/index.ts index 3cf1389013..54cce62cec 100644 --- a/plugins/bitrise/src/index.ts +++ b/plugins/bitrise/src/index.ts @@ -22,4 +22,7 @@ export { bitrisePlugin } from './plugin'; export { EntityBitriseContent } from './extensions'; -export { isBitriseAvailable } from './components/BitriseBuildsComponent'; +export { + isBitriseAvailable, + BITRISE_APP_ANNOTATION, +} from './components/BitriseBuildsComponent'; diff --git a/plugins/bitrise/src/plugin.ts b/plugins/bitrise/src/plugin.ts index 92beda287c..2b75f6d8b5 100644 --- a/plugins/bitrise/src/plugin.ts +++ b/plugins/bitrise/src/plugin.ts @@ -28,6 +28,7 @@ export const bitriseApiRef = createApiRef({ id: 'plugin.bitrise.service', }); +/** @public */ export const bitrisePlugin = createPlugin({ id: 'bitrise', apis: [ diff --git a/scripts/api-extractor.ts b/scripts/api-extractor.ts index 000f0b8c84..b53c5b0769 100644 --- a/scripts/api-extractor.ts +++ b/scripts/api-extractor.ts @@ -199,10 +199,8 @@ const PACKAGE_ROOTS = ['packages', 'plugins']; const ALLOW_WARNINGS = [ 'packages/core-components', - 'plugins/allure', 'plugins/apache-airflow', 'plugins/auth-backend', - 'plugins/bitrise', 'plugins/catalog', 'plugins/catalog-graphql', 'plugins/catalog-import',