From 69eefb5aeb8dd3bb08a2827fb384875d9d05e86a Mon Sep 17 00:00:00 2001 From: Thomas Viaud Date: Fri, 30 Apr 2021 11:13:38 +0100 Subject: [PATCH] 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`.