From c7a6c96d0bf6ed93ac9cf24441badebda5ad1363 Mon Sep 17 00:00:00 2001 From: Johannes Grumboeck Date: Fri, 28 Oct 2022 01:08:07 +0200 Subject: [PATCH 1/3] chore: fix wrong github callback url documentation Signed-off-by: Johannes Grumboeck --- docs/auth/github/provider.md | 2 +- plugins/auth-backend/README.md | 2 +- plugins/github-actions/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/auth/github/provider.md b/docs/auth/github/provider.md index a8c6020cae..353b8ebe08 100644 --- a/docs/auth/github/provider.md +++ b/docs/auth/github/provider.md @@ -24,7 +24,7 @@ Settings for local development: - Application name: Backstage (or your custom app name) - Homepage URL: `http://localhost:3000` -- Authorization callback URL: `http://localhost:7007/api/auth/github` +- Authorization callback URL: `http://localhost:7007/api/auth/github/handler/frame` ## Configuration diff --git a/plugins/auth-backend/README.md b/plugins/auth-backend/README.md index d13a5e5a20..d389d4e97a 100644 --- a/plugins/auth-backend/README.md +++ b/plugins/auth-backend/README.md @@ -34,7 +34,7 @@ Follow this link, [Create new OAuth App](https://github.com/settings/application 1. Set Application Name to `backstage-dev` or something along those lines. 1. You can set the Homepage URL to whatever you want to. 1. The Authorization Callback URL should match the redirect URI set in Backstage. - 1. Set this to `http://localhost:7007/api/auth/github` for local development. + 1. Set this to `http://localhost:7007/api/auth/github/handler/frame` for local development. 1. Set this to `http://{APP_FQDN}:{APP_BACKEND_PORT}/api/auth/github` for non-local deployments. ```bash diff --git a/plugins/github-actions/README.md b/plugins/github-actions/README.md index 792d13280f..cb6867193c 100644 --- a/plugins/github-actions/README.md +++ b/plugins/github-actions/README.md @@ -11,7 +11,7 @@ TBD ### Generic Requirements 1. Provide OAuth credentials: - 1. [Create an OAuth App](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/) in the GitHub organization with the callback URL set to `http://localhost:7007/api/auth/github`. + 1. [Create an OAuth App](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/) in the GitHub organization with the callback URL set to `http://localhost:7007/api/auth/github/handler/frame`. 2. Take the Client ID and Client Secret from the newly created app's settings page and put them into `AUTH_GITHUB_CLIENT_ID` and `AUTH_GITHUB_CLIENT_SECRET` environment variables. 2. Annotate your component with a correct GitHub Actions repository and owner: From 0d6837ca4ec66448816b6b094ed5c866c03dfb8e Mon Sep 17 00:00:00 2001 From: Johannes Grumboeck Date: Fri, 28 Oct 2022 15:42:40 +0200 Subject: [PATCH 2/3] chore: add changeset Signed-off-by: Johannes Grumboeck --- .changeset/cool-suns-add.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/cool-suns-add.md diff --git a/.changeset/cool-suns-add.md b/.changeset/cool-suns-add.md new file mode 100644 index 0000000000..c66de2e2ad --- /dev/null +++ b/.changeset/cool-suns-add.md @@ -0,0 +1,6 @@ +--- +'@backstage/plugin-auth-backend': patch +'@backstage/plugin-github-actions': patch +--- + +Fix wrong GitHub callback URL documentation From 405eab555f35dc8dfc2d4dc8fba20c1c7282bd48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Grumb=C3=B6ck?= Date: Wed, 2 Nov 2022 13:39:12 +0100 Subject: [PATCH 3/3] Fix: missing another occurrence of GH auth callback URL MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Johannes Grumböck --- plugins/auth-backend/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/auth-backend/README.md b/plugins/auth-backend/README.md index d389d4e97a..ba0042c6f9 100644 --- a/plugins/auth-backend/README.md +++ b/plugins/auth-backend/README.md @@ -35,7 +35,7 @@ Follow this link, [Create new OAuth App](https://github.com/settings/application 1. You can set the Homepage URL to whatever you want to. 1. The Authorization Callback URL should match the redirect URI set in Backstage. 1. Set this to `http://localhost:7007/api/auth/github/handler/frame` for local development. - 1. Set this to `http://{APP_FQDN}:{APP_BACKEND_PORT}/api/auth/github` for non-local deployments. + 1. Set this to `http://{APP_FQDN}:{APP_BACKEND_PORT}/api/auth/github/handler/frame` for non-local deployments. ```bash export AUTH_GITHUB_CLIENT_ID=x