CreateGithubPullRequestActionOptions
Home > @backstage/plugin-scaffolder-backend-module-github > CreateGithubPullRequestActionOptions
The options passed to createPublishGithubPullRequestAction method
Signature:
export interface CreateGithubPullRequestActionOptions
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| 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>; }> | (Optional) A method to return the Octokit client with the Pull Request Plugin. | |
| config? | Config | (Optional) An instance of Config that will be used in the action. | |
| githubCredentialsProvider? | GithubCredentialsProvider | (Optional) An instance of GithubCredentialsProvider that will be used to get credentials for the action. | |
| integrations | ScmIntegrationRegistry | An instance of ScmIntegrationRegistry that will be used in the action. |