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,283 @@
+## API Report File for "@backstage/plugin-cloudbuild"
+
+> 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 { Entity } from '@backstage/catalog-model';
+import { OAuthApi } from '@backstage/core';
+import { RouteRef } from '@backstage/core';
+
+// @public (undocumented)
+export type ActionsGetWorkflowResponseData = {
+    id: string;
+    status: string;
+    source: Source;
+    createTime: string;
+    startTime: string;
+    steps: Step[];
+    timeout: string;
+    projectId: string;
+    logsBucket: string;
+    sourceProvenance: SourceProvenance;
+    buildTriggerId: string;
+    options: Options;
+    logUrl: string;
+    substitutions: Substitutions;
+    tags: string[];
+    queueTtl: string;
+    name: string;
+    finishTime: any;
+    results: Results;
+    timing: Timing2;
+};
+
+// @public (undocumented)
+export interface ActionsListWorkflowRunsForRepoResponseData {
+    // (undocumented)
+    builds: ActionsGetWorkflowResponseData[];
+}
+
+// @public (undocumented)
+export interface BUILD {
+    // (undocumented)
+    endTime: string;
+    // (undocumented)
+    startTime: string;
+}
+
+// @public (undocumented)
+export const CLOUDBUILD_ANNOTATION = "google.com/cloudbuild-project-slug";
+
+// @public (undocumented)
+export type CloudbuildApi = {
+    listWorkflowRuns: (request: {
+        projectId: string;
+    }) => Promise<ActionsListWorkflowRunsForRepoResponseData>;
+    getWorkflow: ({ projectId, id, }: {
+        projectId: string;
+        id: string;
+    }) => Promise<ActionsGetWorkflowResponseData>;
+    getWorkflowRun: ({ projectId, id, }: {
+        projectId: string;
+        id: string;
+    }) => Promise<ActionsGetWorkflowResponseData>;
+    reRunWorkflow: ({ projectId, runId, }: {
+        projectId: string;
+        runId: string;
+    }) => Promise<any>;
+};
+
+// @public (undocumented)
+export const cloudbuildApiRef: ApiRef<CloudbuildApi>;
+
+// @public (undocumented)
+export class CloudbuildClient implements CloudbuildApi {
+    constructor(googleAuthApi: OAuthApi);
+    // (undocumented)
+    getToken(): Promise<string>;
+    // (undocumented)
+    getWorkflow({ projectId, id, }: {
+        projectId: string;
+        id: string;
+    }): Promise<ActionsGetWorkflowResponseData>;
+    // (undocumented)
+    getWorkflowRun({ projectId, id, }: {
+        projectId: string;
+        id: string;
+    }): Promise<ActionsGetWorkflowResponseData>;
+    // (undocumented)
+    listWorkflowRuns({ projectId, }: {
+        projectId: string;
+    }): Promise<ActionsListWorkflowRunsForRepoResponseData>;
+    // (undocumented)
+    reRunWorkflow({ projectId, runId, }: {
+        projectId: string;
+        runId: string;
+    }): Promise<void>;
+}
+
+// @public (undocumented)
+const cloudbuildPlugin: BackstagePlugin<{
+    entityContent: RouteRef<undefined>;
+}, {}>;
+
+export { cloudbuildPlugin }
+
+export { cloudbuildPlugin as plugin }
+
+// @public (undocumented)
+export const EntityCloudbuildContent: (_props: {
+    entity?: Entity| undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const EntityLatestCloudbuildRunCard: ({ branch, }: {
+    entity?: Entity| undefined;
+    branch: string;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const EntityLatestCloudbuildsForBranchCard: ({ branch, }: {
+    entity?: Entity| undefined;
+    branch: string;
+}) => JSX.Element;
+
+// @public (undocumented)
+export interface FETCHSOURCE {
+    // (undocumented)
+    endTime: string;
+    // (undocumented)
+    startTime: string;
+}
+
+// @public (undocumented)
+const isCloudbuildAvailable: (entity: Entity) => boolean;
+
+export { isCloudbuildAvailable }
+
+export { isCloudbuildAvailable as isPluginApplicableToEntity }
+
+// @public (undocumented)
+export const LatestWorkflowRunCard: ({ branch, }: {
+    entity?: Entity | undefined;
+    branch: string;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const LatestWorkflowsForBranchCard: ({ branch, }: {
+    entity?: Entity | undefined;
+    branch: string;
+}) => JSX.Element;
+
+// @public (undocumented)
+export interface Options {
+    // (undocumented)
+    dynamicSubstitutions: boolean;
+    // (undocumented)
+    logging: string;
+    // (undocumented)
+    machineType: string;
+    // (undocumented)
+    substitutionOption: string;
+}
+
+// @public (undocumented)
+export interface PullTiming {
+    // (undocumented)
+    endTime: string;
+    // (undocumented)
+    startTime: string;
+}
+
+// @public (undocumented)
+export interface ResolvedStorageSource {
+    // (undocumented)
+    bucket: string;
+    // (undocumented)
+    generation: string;
+    // (undocumented)
+    object: string;
+}
+
+// @public (undocumented)
+export interface Results {
+    // (undocumented)
+    buildStepImages: string[];
+    // (undocumented)
+    buildStepOutputs: string[];
+}
+
+// @public (undocumented)
+export const Router: (_props: Props) => JSX.Element;
+
+// @public (undocumented)
+export interface Source {
+    // (undocumented)
+    storageSource: StorageSource;
+}
+
+// @public (undocumented)
+export interface SourceProvenance {
+    // (undocumented)
+    fileHashes: {};
+    // (undocumented)
+    resolvedStorageSource: {};
+}
+
+// @public (undocumented)
+export interface Step {
+    // (undocumented)
+    args: string[];
+    // (undocumented)
+    dir: string;
+    // (undocumented)
+    entrypoint: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    pullTiming: PullTiming;
+    // (undocumented)
+    status: string;
+    // (undocumented)
+    timing: Timing;
+    // (undocumented)
+    volumes: Volume[];
+    // (undocumented)
+    waitFor: string[];
+}
+
+// @public (undocumented)
+export interface StorageSource {
+    // (undocumented)
+    bucket: string;
+    // (undocumented)
+    object: string;
+}
+
+// @public (undocumented)
+export interface Substitutions {
+    // (undocumented)
+    BRANCH_NAME: string;
+    // (undocumented)
+    COMMIT_SHA: string;
+    // (undocumented)
+    REPO_NAME: string;
+    // (undocumented)
+    REVISION_ID: string;
+    // (undocumented)
+    SHORT_SHA: string;
+}
+
+// @public (undocumented)
+export interface Timing {
+    // (undocumented)
+    endTime: string;
+    // (undocumented)
+    startTime: string;
+}
+
+// @public (undocumented)
+export interface Timing2 {
+    // (undocumented)
+    BUILD: BUILD;
+    // (undocumented)
+    FETCHSOURCE: FETCHSOURCE;
+}
+
+// @public (undocumented)
+export interface Volume {
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    path: string;
+}
+
+
+// (No @packageDocumentation comment for this package)
+
+```