diff --git a/.changeset/young-beans-float.md b/.changeset/young-beans-float.md index 1f05c4cb26..3adbbba692 100644 --- a/.changeset/young-beans-float.md +++ b/.changeset/young-beans-float.md @@ -1,5 +1,5 @@ --- -'@backstage/plugin-lighthouse': minor +'@backstage/plugin-lighthouse': patch --- Require @backstage/plugin-lighthouse-common package where API implementation moved to diff --git a/example.yaml b/example.yaml deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/plugins/lighthouse-backend/README.md b/plugins/lighthouse-backend/README.md index 2db7ffa583..82a66d6053 100644 --- a/plugins/lighthouse-backend/README.md +++ b/plugins/lighthouse-backend/README.md @@ -26,7 +26,7 @@ export default async function createPlugin(env: PluginEnvironment) { discoveryApi: env.discovery, }); - await create({ logger, scheduler, config, catalogClient }); + await createScheduler({ logger, scheduler, config, catalogClient }); } ``` diff --git a/plugins/lighthouse-backend/api-report.md b/plugins/lighthouse-backend/api-report.md index d83b73fc20..a91e47dfc5 100644 --- a/plugins/lighthouse-backend/api-report.md +++ b/plugins/lighthouse-backend/api-report.md @@ -8,15 +8,8 @@ import { Config } from '@backstage/config'; import { Logger } from 'winston'; import { PluginTaskScheduler } from '@backstage/backend-tasks'; -// Warning: (ae-missing-release-tag) "create" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) -export function create(options: Options): Promise; - -// Warning: (ae-missing-release-tag) "Options" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) -export interface Options { +export interface CreateLighthouseSchedulerOptions { // (undocumented) catalogClient: CatalogClient; // (undocumented) @@ -27,5 +20,10 @@ export interface Options { scheduler?: PluginTaskScheduler; } +// @public (undocumented) +export function createScheduler( + options: CreateLighthouseSchedulerOptions, +): Promise; + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/lighthouse-backend/package.json b/plugins/lighthouse-backend/package.json index 91ef1a4765..f092d93202 100644 --- a/plugins/lighthouse-backend/package.json +++ b/plugins/lighthouse-backend/package.json @@ -49,10 +49,5 @@ }, "devDependencies": { "@backstage/cli": "workspace:^" - }, - "jest": { - "roots": [ - ".." - ] } } diff --git a/plugins/lighthouse-backend/src/service/plugin.ts b/plugins/lighthouse-backend/src/service/plugin.ts index c2baf9fbf5..8e8952a3d6 100644 --- a/plugins/lighthouse-backend/src/service/plugin.ts +++ b/plugins/lighthouse-backend/src/service/plugin.ts @@ -25,14 +25,18 @@ import { LighthouseRestApi } from '@backstage/plugin-lighthouse-common'; import { stringifyEntityRef } from '@backstage/catalog-model'; import { LighthouseAuditScheduleImpl } from '../config'; -export interface Options { +/** @public **/ +export interface CreateLighthouseSchedulerOptions { logger: Logger; config: Config; scheduler?: PluginTaskScheduler; catalogClient: CatalogClient; } -export async function create(options: Options) { +/** @public **/ +export async function createScheduler( + options: CreateLighthouseSchedulerOptions, +) { const { logger, scheduler, catalogClient, config } = options; const lighthouseApi = LighthouseRestApi.fromConfig(config); diff --git a/plugins/lighthouse-common/package.json b/plugins/lighthouse-common/package.json index f8c4cbc798..8dcc00960d 100644 --- a/plugins/lighthouse-common/package.json +++ b/plugins/lighthouse-common/package.json @@ -42,10 +42,5 @@ }, "devDependencies": { "@backstage/cli": "workspace:^" - }, - "jest": { - "roots": [ - ".." - ] } }