diff --git a/.changeset/loud-jars-kick.md b/.changeset/loud-jars-kick.md new file mode 100644 index 0000000000..b53006f7f9 --- /dev/null +++ b/.changeset/loud-jars-kick.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-allure': patch +--- + +Add export for `isAllureReportAvailable` and `ALLURE_PROJECT_ID_ANNOTATION` so it can be used outside of plugin diff --git a/plugins/allure/api-report.md b/plugins/allure/api-report.md index 5489ba4f26..c5c4253cd4 100644 --- a/plugins/allure/api-report.md +++ b/plugins/allure/api-report.md @@ -6,8 +6,14 @@ /// 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) @@ -22,4 +28,9 @@ export const allurePlugin: BackstagePlugin< // // @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/index.ts b/plugins/allure/src/index.ts index d9dbfab056..4fae28258d 100644 --- a/plugins/allure/src/index.ts +++ b/plugins/allure/src/index.ts @@ -21,3 +21,7 @@ */ export { allurePlugin, EntityAllureReportContent } from './plugin'; +export { + isAllureReportAvailable, + ALLURE_PROJECT_ID_ANNOTATION, +} from './components/annotationHelpers';