Version: Next

getOctokitOptions()

Home > @backstage/plugin-scaffolder-backend-module-github > getOctokitOptions

Helper for generating octokit configuration options for given repoUrl. If no token is provided, it will attempt to get a token from the credentials provider.

Signature:

function getOctokitOptions(options: {
    integrations: ScmIntegrationRegistry;
    credentialsProvider?: GithubCredentialsProvider;
    token?: string;
    repoUrl: string;
}): Promise<OctokitOptions>;

Parameters

Parameter	Type	Description
options	{ integrations: ScmIntegrationRegistry; credentialsProvider?: GithubCredentialsProvider; token?: string; repoUrl: string; }

**Returns:**

Promise<OctokitOptions>

Parameters​

Parameters