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,213 @@
+## API Report File for "@backstage/plugin-github-actions"
+
+> 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 { ConfigApi } from '@backstage/core';
+import { Entity } from '@backstage/catalog-model';
+import { InfoCardVariants } from '@backstage/core';
+import { OAuthApi } from '@backstage/core';
+import { RestEndpointMethodTypes } from '@octokit/rest';
+import { RouteRef } from '@backstage/core';
+
+// @public (undocumented)
+export enum BuildStatus {
+    // (undocumented)
+    'failure' = 1,
+    // (undocumented)
+    'pending' = 2,
+    // (undocumented)
+    'running' = 3,
+    // (undocumented)
+    'success' = 0
+}
+
+// @public (undocumented)
+export const EntityGithubActionsContent: (_props: {
+    entity?: Entity| undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const EntityLatestGithubActionRunCard: ({ branch, variant, }: {
+    entity?: Entity| undefined;
+    branch: string;
+    variant?: InfoCardVariants| undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const EntityLatestGithubActionsForBranchCard: ({ branch, variant, }: {
+    entity?: Entity| undefined;
+    branch: string;
+    variant?: InfoCardVariants| undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const EntityRecentGithubActionsRunsCard: ({ branch, dense, limit, variant, }: Props) => JSX.Element;
+
+// @public (undocumented)
+export const GITHUB_ACTIONS_ANNOTATION = "github.com/project-slug";
+
+// @public (undocumented)
+export type GithubActionsApi = {
+    listWorkflowRuns: ({ hostname, owner, repo, pageSize, page, branch, }: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        pageSize?: number;
+        page?: number;
+        branch?: string;
+    }) => Promise<RestEndpointMethodTypes['actions']['listWorkflowRuns']['response']['data']>;
+    getWorkflow: ({ hostname, owner, repo, id, }: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        id: number;
+    }) => Promise<RestEndpointMethodTypes['actions']['getWorkflow']['response']['data']>;
+    getWorkflowRun: ({ hostname, owner, repo, id, }: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        id: number;
+    }) => Promise<RestEndpointMethodTypes['actions']['getWorkflowRun']['response']['data']>;
+    reRunWorkflow: ({ hostname, owner, repo, runId, }: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        runId: number;
+    }) => Promise<any>;
+    listJobsForWorkflowRun: ({ hostname, owner, repo, id, pageSize, page, }: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        id: number;
+        pageSize?: number;
+        page?: number;
+    }) => Promise<RestEndpointMethodTypes['actions']['listJobsForWorkflowRun']['response']['data']>;
+    downloadJobLogsForWorkflowRun: ({ hostname, owner, repo, runId, }: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        runId: number;
+    }) => Promise<RestEndpointMethodTypes['actions']['downloadJobLogsForWorkflowRun']['response']['data']>;
+};
+
+// @public (undocumented)
+export const githubActionsApiRef: ApiRef<GithubActionsApi>;
+
+// @public (undocumented)
+export class GithubActionsClient implements GithubActionsApi {
+    constructor(options: {
+        configApi: ConfigApi;
+        githubAuthApi: OAuthApi;
+    });
+    // (undocumented)
+    downloadJobLogsForWorkflowRun({ hostname, owner, repo, runId, }: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        runId: number;
+    }): Promise<RestEndpointMethodTypes['actions']['downloadJobLogsForWorkflowRun']['response']['data']>;
+    // (undocumented)
+    getWorkflow({ hostname, owner, repo, id, }: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        id: number;
+    }): Promise<RestEndpointMethodTypes['actions']['getWorkflow']['response']['data']>;
+    // (undocumented)
+    getWorkflowRun({ hostname, owner, repo, id, }: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        id: number;
+    }): Promise<RestEndpointMethodTypes['actions']['getWorkflowRun']['response']['data']>;
+    // (undocumented)
+    listJobsForWorkflowRun({ hostname, owner, repo, id, pageSize, page, }: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        id: number;
+        pageSize?: number;
+        page?: number;
+    }): Promise<RestEndpointMethodTypes['actions']['listJobsForWorkflowRun']['response']['data']>;
+    // (undocumented)
+    listWorkflowRuns({ hostname, owner, repo, pageSize, page, branch, }: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        pageSize?: number;
+        page?: number;
+        branch?: string;
+    }): Promise<RestEndpointMethodTypes['actions']['listWorkflowRuns']['response']['data']>;
+    // (undocumented)
+    reRunWorkflow({ hostname, owner, repo, runId, }: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        runId: number;
+    }): Promise<any>;
+}
+
+// @public (undocumented)
+const githubActionsPlugin: BackstagePlugin<{
+    entityContent: RouteRef<undefined>;
+}, {}>;
+
+export { githubActionsPlugin }
+
+export { githubActionsPlugin as plugin }
+
+// @public (undocumented)
+const isGithubActionsAvailable: (entity: Entity) => boolean;
+
+export { isGithubActionsAvailable }
+
+export { isGithubActionsAvailable as isPluginApplicableToEntity }
+
+// @public (undocumented)
+export type Job = {
+    html_url: string;
+    status: string;
+    conclusion: string;
+    started_at: string;
+    completed_at: string;
+    id: number;
+    name: string;
+    steps: Step[];
+};
+
+// @public (undocumented)
+export type Jobs = {
+    total_count: number;
+    jobs: Job[];
+};
+
+// @public (undocumented)
+export const LatestWorkflowRunCard: ({ branch, variant, }: Props_3) => JSX.Element;
+
+// @public (undocumented)
+export const LatestWorkflowsForBranchCard: ({ branch, variant, }: Props_3) => JSX.Element;
+
+// @public (undocumented)
+export const RecentWorkflowRunsCard: ({ branch, dense, limit, variant, }: Props) => JSX.Element;
+
+// @public (undocumented)
+export const Router: (_props: Props_2) => JSX.Element;
+
+// @public (undocumented)
+export type Step = {
+    name: string;
+    status: string;
+    conclusion?: string;
+    number: number;
+    started_at: string;
+    completed_at: string;
+};
+
+
+// (No @packageDocumentation comment for this package)
+
+```