diff --git a/plugins/scaffolder-backend-module-github/report.api.md b/plugins/scaffolder-backend-module-github/report.api.md index 9e930a7866..84e71c712a 100644 --- a/plugins/scaffolder-backend-module-github/report.api.md +++ b/plugins/scaffolder-backend-module-github/report.api.md @@ -8,6 +8,7 @@ import { CatalogService } from '@backstage/plugin-catalog-node'; import { Config } from '@backstage/config'; import { createPullRequest } from 'octokit-plugin-create-pull-request'; import { GithubCredentialsProvider } from '@backstage/integration'; +import { LoggerService } from '@backstage/backend-plugin-api'; import { Octokit } from 'octokit'; import { OctokitOptions } from '@octokit/core/dist-types/types'; import { ScmIntegrationRegistry } from '@backstage/integration'; @@ -253,8 +254,8 @@ export function createGithubRepoCreateAction(options: { access: string; } | { - team: string; access: string; + team: string; } )[] | undefined; @@ -444,8 +445,8 @@ export function createPublishGithubAction(options: { access: string; } | { - team: string; access: string; + team: string; } )[] | undefined; @@ -509,6 +510,13 @@ export const createPublishGithubPullRequestAction: ( 'v2' >; +// @public +export function getOctokitClient( + octokitOptions: OctokitOptions, + logger: LoggerService, + retryOptions?: RetryOptions, +): Octokit; + // @public export function getOctokitOptions(options: { integrations: ScmIntegrationRegistry; @@ -530,4 +538,10 @@ export function getOctokitOptions(options: { // @public const githubModule: BackendFeature; export default githubModule; + +// @public +export type RetryOptions = { + retries?: number; + retryAfter?: number; +}; ``` diff --git a/plugins/scaffolder-backend-module-github/src/util.ts b/plugins/scaffolder-backend-module-github/src/util.ts index f9cd695b83..5e537582ca 100644 --- a/plugins/scaffolder-backend-module-github/src/util.ts +++ b/plugins/scaffolder-backend-module-github/src/util.ts @@ -33,6 +33,10 @@ const DEFAULT_TIMEOUT_MS = 60_000; const DEFAULT_RETRY_ATTEMPTS = 3; const DEFAULT_RETRY_DELAY_MS = 1_000; +/** + * Options used to override the default retry behavior of @octokit/plugin-retry. + * @public + */ export type RetryOptions = { // The number of retry attempts for failed requests retries?: number;