diff --git a/plugins/jenkins-backend/api-report.md b/plugins/jenkins-backend/api-report.md new file mode 100644 index 0000000000..aa89e1c897 --- /dev/null +++ b/plugins/jenkins-backend/api-report.md @@ -0,0 +1,69 @@ +## API Report File for "@backstage/plugin-jenkins-backend" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { CatalogClient } from '@backstage/catalog-client'; +import { Config } from '@backstage/config'; +import { EntityName } from '@backstage/catalog-model'; +import express from 'express'; +import { Logger } from 'winston'; + +// @public (undocumented) +export function createRouter(options: RouterOptions): Promise; + +// @public +export class DefaultJenkinsInfoProvider implements JenkinsInfoProvider { + constructor(catalog: CatalogClient, config: Config); + // (undocumented) + getInstance(opt: { + entityRef: EntityName; + jobName?: string; + }): Promise; + // (undocumented) + static readonly NEW_JENKINS_ANNOTATION = "jenkins.io/job-slug"; + // (undocumented) + static readonly OLD_JENKINS_ANNOTATION = "jenkins.io/github-folder"; +} + +// @public (undocumented) +export class DummyJenkinsInfoProvider implements JenkinsInfoProvider { + // (undocumented) + getInstance(_: { + entityRef: EntityName; + jobName?: string; + }): Promise; +} + +// @public (undocumented) +export interface JenkinsInfo { + // (undocumented) + baseUrl: string; + // (undocumented) + headers?: any; + // (undocumented) + jobName: string; +} + +// @public (undocumented) +export interface JenkinsInfoProvider { + // (undocumented) + getInstance(options: { + entityRef: EntityName; + jobName?: string; + }): Promise; +} + +// @public (undocumented) +export interface RouterOptions { + // (undocumented) + jenkinsInfoProvider: JenkinsInfoProvider; + // (undocumented) + logger: Logger; +} + + +// (No @packageDocumentation comment for this package) + +``` diff --git a/plugins/jenkins/src/index.ts b/plugins/jenkins/src/index.ts index fb0a27cb26..1a72b438ab 100644 --- a/plugins/jenkins/src/index.ts +++ b/plugins/jenkins/src/index.ts @@ -27,4 +27,3 @@ export { isJenkinsAvailable as isPluginApplicableToEntity, } from './components/Router'; export { JENKINS_ANNOTATION } from './constants'; -export * from './api';