From b000ee6fa2f28cbcf0edcf9ae15703b352fc59ac Mon Sep 17 00:00:00 2001 From: Matheus Castiglioni Date: Sun, 5 May 2024 22:12:18 -0300 Subject: [PATCH] fix(plugins/scaffolder-backend-module-github): api report config undocumented Signed-off-by: Matheus Castiglioni --- plugins/scaffolder-backend-module-github/api-report.md | 1 - .../src/actions/githubPullRequest.ts | 3 +++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/plugins/scaffolder-backend-module-github/api-report.md b/plugins/scaffolder-backend-module-github/api-report.md index cac2a3fee2..4f3cd819ad 100644 --- a/plugins/scaffolder-backend-module-github/api-report.md +++ b/plugins/scaffolder-backend-module-github/api-report.md @@ -128,7 +128,6 @@ export interface CreateGithubPullRequestActionOptions { } | null>; } >; - // (undocumented) config: Config; githubCredentialsProvider?: GithubCredentialsProvider; integrations: ScmIntegrationRegistry; diff --git a/plugins/scaffolder-backend-module-github/src/actions/githubPullRequest.ts b/plugins/scaffolder-backend-module-github/src/actions/githubPullRequest.ts index 3c40361af3..cc5e1280ef 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/githubPullRequest.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/githubPullRequest.ts @@ -101,6 +101,9 @@ export interface CreateGithubPullRequestActionOptions { } | null>; } >; + /** + * An instance of {@link @backstage/config#Config} that will be used in the action. + */ config: Config; }