plugins: generate api reports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-17 11:00:16 +02:00
parent 5429bfa69e
commit d8d7226fce
54 changed files with 5209 additions and 0 deletions
@@ -0,0 +1,83 @@
+## API Report File for "@backstage/plugin-jenkins"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ApiRef } from '@backstage/core';
+import { BackstagePlugin } from '@backstage/core';
+import { DiscoveryApi } from '@backstage/core';
+import { Entity } from '@backstage/catalog-model';
+import { InfoCardVariants } from '@backstage/core';
+import { RouteRef } from '@backstage/core';
+
+// @public (undocumented)
+export const EntityJenkinsContent: (_props: {
+    entity?: Entity| undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const EntityLatestJenkinsRunCard: ({ branch, variant, }: {
+    branch: string;
+    variant?: InfoCardVariants| undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+const isJenkinsAvailable: (entity: Entity) => boolean;
+
+export { isJenkinsAvailable }
+
+export { isJenkinsAvailable as isPluginApplicableToEntity }
+
+// @public (undocumented)
+export const JENKINS_ANNOTATION = "jenkins.io/github-folder";
+
+// @public (undocumented)
+export class JenkinsApi {
+    constructor(options: Options);
+    // (undocumented)
+    extractJobDetailsFromBuildName(buildName: string): {
+        jobName: string;
+        buildNumber: number;
+    };
+    // (undocumented)
+    extractScmDetailsFromJob(jobDetails: any): any | undefined;
+    // (undocumented)
+    getBuild(buildName: string): Promise<any>;
+    // (undocumented)
+    getFolder(folderName: string): Promise<CITableBuildInfo[]>;
+    // (undocumented)
+    getJob(jobName: string): Promise<any>;
+    // (undocumented)
+    getLastBuild(jobName: string): Promise<any>;
+    // (undocumented)
+    mapJenkinsBuildToCITable(jenkinsResult: any, jobScmInfo?: any): CITableBuildInfo;
+    // (undocumented)
+    retry(buildName: string): Promise<any>;
+}
+
+// @public (undocumented)
+export const jenkinsApiRef: ApiRef<JenkinsApi>;
+
+// @public (undocumented)
+const jenkinsPlugin: BackstagePlugin<{
+    entityContent: RouteRef<undefined>;
+}, {}>;
+
+export { jenkinsPlugin }
+
+export { jenkinsPlugin as plugin }
+
+// @public (undocumented)
+export const LatestRunCard: ({ branch, variant, }: {
+    branch: string;
+    variant?: InfoCardVariants | undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const Router: (_props: Props) => JSX.Element;
+
+
+// (No @packageDocumentation comment for this package)
+
+```