From 3816ee1a91aee34a07ad9118527827213e05e69e Mon Sep 17 00:00:00 2001 From: Thomas Viaud Date: Fri, 30 Apr 2021 11:12:19 +0100 Subject: [PATCH 1/4] feat(scaffolder-backend,githubPR): Fixing Github URL submitted to get credentials Signed-off-by: Thomas Viaud --- .../scaffolder/actions/builtin/publish/githubPullRequest.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts index e2e4f17efb..18aef2b54c 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts @@ -29,7 +29,7 @@ import { InputError, CustomErrorBase } from '@backstage/errors'; import { createPullRequest } from 'octokit-plugin-create-pull-request'; import globby from 'globby'; -class GithubResponseError extends CustomErrorBase {} +class GithubResponseError extends CustomErrorBase { } type CreatePullRequestResponse = { data: { html_url: string }; @@ -87,7 +87,7 @@ export const defaultClientFactory = async ({ } const { token } = await credentialsProvider.getCredentials({ - url: `${host}/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}`, + url: `https://${host}/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}`, }); if (!token) { From 69eefb5aeb8dd3bb08a2827fb384875d9d05e86a Mon Sep 17 00:00:00 2001 From: Thomas Viaud Date: Fri, 30 Apr 2021 11:13:38 +0100 Subject: [PATCH 2/4] feat(scaffolder-backend,doc): Adding Documentation for plugin Signed-off-by: Thomas Viaud --- .changeset/old-horses-brake.md | 6 ++++++ plugins/scaffolder-backend/README.md | 17 ++++++++++++++--- 2 files changed, 20 insertions(+), 3 deletions(-) create mode 100644 .changeset/old-horses-brake.md diff --git a/.changeset/old-horses-brake.md b/.changeset/old-horses-brake.md new file mode 100644 index 0000000000..ea41019b23 --- /dev/null +++ b/.changeset/old-horses-brake.md @@ -0,0 +1,6 @@ +--- +'@backstage/plugin-scaffolder-backend': patch +--- + +Fix GithubPR built-in action `credentialsProvider.getCredentials` URL. +Adding Documentation for GitHub PR built-in action. diff --git a/plugins/scaffolder-backend/README.md b/plugins/scaffolder-backend/README.md index 185938b006..2e8cc41ace 100644 --- a/plugins/scaffolder-backend/README.md +++ b/plugins/scaffolder-backend/README.md @@ -1,7 +1,18 @@ -# Title +# Scaffolder Backend Welcome to the scaffolder plugin! -## Sub-section 1 +## Jobs +Documentation for `Jobs` here +## Stages +Documentation for `Stages` here +## Tasks +Documentation for `Tasks` here -## Sub-section 2 +## Actions +### Built-in: +* #### GitHub Pull Request + * Minimum permissions required for GitHub App for creating a Pull Request with the built-in action: + - Read and Write permissions for `Contents`. + - Read and write permissions for `Pull Requests` and `Issues`. + - Read permissions on `Metadata`. From 900cb4c39d440e90eab2492d4df5eeb55ec9353c Mon Sep 17 00:00:00 2001 From: Thomas Viaud Date: Fri, 30 Apr 2021 11:28:59 +0100 Subject: [PATCH 3/4] Run Prettier on scaffolder-backend files Signed-off-by: Thomas Viaud --- plugins/scaffolder-backend/README.md | 17 ++++++++++++----- .../builtin/publish/githubPullRequest.ts | 4 +++- 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/plugins/scaffolder-backend/README.md b/plugins/scaffolder-backend/README.md index 2e8cc41ace..304d43a750 100644 --- a/plugins/scaffolder-backend/README.md +++ b/plugins/scaffolder-backend/README.md @@ -3,16 +3,23 @@ Welcome to the scaffolder plugin! ## Jobs + Documentation for `Jobs` here + ## Stages + Documentation for `Stages` here + ## Tasks + Documentation for `Tasks` here ## Actions + ### Built-in: -* #### GitHub Pull Request - * Minimum permissions required for GitHub App for creating a Pull Request with the built-in action: - - Read and Write permissions for `Contents`. - - Read and write permissions for `Pull Requests` and `Issues`. - - Read permissions on `Metadata`. + +- #### GitHub Pull Request + - Minimum permissions required for GitHub App for creating a Pull Request with the built-in action: + - Read and Write permissions for `Contents`. + - Read and write permissions for `Pull Requests` and `Issues`. + - Read permissions on `Metadata`. diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts index 18aef2b54c..8f44fc3e19 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts @@ -87,7 +87,9 @@ export const defaultClientFactory = async ({ } const { token } = await credentialsProvider.getCredentials({ - url: `https://${host}/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}`, + url: `https://${host}/${encodeURIComponent(owner)}/${encodeURIComponent( + repo, + )}`, }); if (!token) { From 939b9d0fffdd69fb2cc976d93ac2d4baec15f0cf Mon Sep 17 00:00:00 2001 From: Thomas Viaud Date: Fri, 30 Apr 2021 11:38:11 +0100 Subject: [PATCH 4/4] Fixing Prettier Warning Signed-off-by: Thomas Viaud --- .../src/scaffolder/actions/builtin/publish/githubPullRequest.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts index 8f44fc3e19..5dd4046811 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts @@ -29,7 +29,7 @@ import { InputError, CustomErrorBase } from '@backstage/errors'; import { createPullRequest } from 'octokit-plugin-create-pull-request'; import globby from 'globby'; -class GithubResponseError extends CustomErrorBase { } +class GithubResponseError extends CustomErrorBase {} type CreatePullRequestResponse = { data: { html_url: string };