Skip to main content
Version: Next

CreateGithubPullRequestActionOptions.clientFactory

Home > @backstage/plugin-scaffolder-backend-module-github > CreateGithubPullRequestActionOptions > clientFactory

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

Signature:

clientFactory?: (input: {
integrations: ScmIntegrationRegistry;
githubCredentialsProvider?: GithubCredentialsProvider;
host: string;
owner: string;
repo: string;
token?: string;
}) => Promise<Octokit & {
createPullRequest(options: createPullRequest.Options): Promise<{
data: {
html_url: string;
number: number;
base: {
ref: string;
};
};
} | null>;
}>;