Function getOctokitOptions

getOctokitOptions(
    options: {
        credentialsProvider?: GithubCredentialsProvider;
        host: string;
        integrations: ScmIntegrationRegistry;
        owner?: string;
        repo?: string;
        requireScmUserCredentials?: boolean;
        token?: string;
    },
): Promise<OctokitOptions>
Helper for generating octokit configuration options. If no token is provided, it will attempt to get a token from the credentials provider.
Parameters
- options: {
      credentialsProvider?: GithubCredentialsProvider;
      host: string;
      integrations: ScmIntegrationRegistry;
      owner?: string;
      repo?: string;
      requireScmUserCredentials?: boolean;
      token?: string;
  }
Returns Promise<OctokitOptions>
- Defined in plugins/scaffolder-backend-module-github/src/util.ts:134
getOctokitOptions(
    options: {
        credentialsProvider?: GithubCredentialsProvider;
        integrations: ScmIntegrationRegistry;
        repoUrl: string;
        requireScmUserCredentials?: boolean;
        token?: string;
    },
): Promise<OctokitOptions>
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.
Parameters
- options: {
      credentialsProvider?: GithubCredentialsProvider;
      integrations: ScmIntegrationRegistry;
      repoUrl: string;
      requireScmUserCredentials?: boolean;
      token?: string;
  }
Returns Promise<OctokitOptions>

Deprecated
Use options host, owner and repo instead of repoUrl.
- Defined in plugins/scaffolder-backend-module-github/src/util.ts:150

Function getOctokitOptions

Parameters

Returns Promise<OctokitOptions>

Parameters

Returns Promise<OctokitOptions>

Deprecated

Settings