Backstage
    Preparing search index...

    The options passed to createPublishGithubPullRequestAction method

    interface CreateGithubPullRequestActionOptions {
        clientFactory?: (
            input: {
                githubCredentialsProvider?: GithubCredentialsProvider;
                host: string;
                integrations: ScmIntegrationRegistry;
                owner: string;
                repo: string;
                token?: string;
            },
        ) => Promise<
            Octokit & { paginate: PaginateInterface } & {
                graphql: graphql & {
                    paginate: <ResponseType_1 extends object = any>(
                        query: string,
                        initialParameters?: Record<(...), (...)>,
                    ) => Promise<ResponseType_1> & {
                        iterator: <ResponseType_2 = any>(
                            query: string,
                            initialParameters?: (...) | (...),
                        ) => { "[asyncIterator]": ... };
                    };
                };
            } & Api & {
                retry: {
                    retryRequest: (
                        error: RequestError,
                        retries: number,
                        retryAfter: number,
                    ) => RequestError;
                };
            } & {
                createPullRequest(
                    options: Options,
                ): Promise<
                    | {
                        data: { base: { ref: string }; html_url: string; number: number };
                    }
                    | null,
                >;
            },
        >;
        config?: Config;
        githubCredentialsProvider?: GithubCredentialsProvider;
        integrations: ScmIntegrationRegistry;
    }
    Index

    Properties

    clientFactory?: (
        input: {
            githubCredentialsProvider?: GithubCredentialsProvider;
            host: string;
            integrations: ScmIntegrationRegistry;
            owner: string;
            repo: string;
            token?: string;
        },
    ) => Promise<
        Octokit & { paginate: PaginateInterface } & {
            graphql: graphql & {
                paginate: <ResponseType_1 extends object = any>(
                    query: string,
                    initialParameters?: Record<(...), (...)>,
                ) => Promise<ResponseType_1> & {
                    iterator: <ResponseType_2 = any>(
                        query: string,
                        initialParameters?: (...) | (...),
                    ) => { "[asyncIterator]": ... };
                };
            };
        } & Api & {
            retry: {
                retryRequest: (
                    error: RequestError,
                    retries: number,
                    retryAfter: number,
                ) => RequestError;
            };
        } & {
            createPullRequest(
                options: Options,
            ): Promise<
                | {
                    data: { base: { ref: string }; html_url: string; number: number };
                }
                | null,
            >;
        },
    >

    A method to return the Octokit client with the Pull Request Plugin.

    config?: Config

    An instance of @backstage/config#Config that will be used in the action.

    githubCredentialsProvider?: GithubCredentialsProvider

    An instance of @backstage/integration#GithubCredentialsProvider that will be used to get credentials for the action.

    An instance of @backstage/integration#ScmIntegrationRegistry that will be used in the action.