From 88a88ab0c8628e4657d734337f1f1329760c9b95 Mon Sep 17 00:00:00 2001 From: Tim Hansen Date: Thu, 20 May 2021 20:15:46 -0600 Subject: [PATCH] Remove deprecated github-org processor config Signed-off-by: Tim Hansen --- docs/integrations/github/org.md | 31 +++++++------------------------ 1 file changed, 7 insertions(+), 24 deletions(-) diff --git a/docs/integrations/github/org.md b/docs/integrations/github/org.md index 4a1bf88932..48e2193696 100644 --- a/docs/integrations/github/org.md +++ b/docs/integrations/github/org.md @@ -22,8 +22,8 @@ entities that mirror your org setup. The processor that performs the import, `GithubOrgReaderProcessor`, comes installed with the default setup of Backstage. -If you replace the set of processors in your installation using that facility of -the catalog builder class, you can import and add it as follows. +If you have _replaced_ the set of processors in your installation using +`replaceProcessors`, you can import and add it as follows: ```ts // Typically in packages/backend/src/plugins/catalog.ts @@ -45,30 +45,13 @@ catalog: locations: - type: github-org target: https://github.com/my-org-name - processors: - githubOrg: - providers: - - target: https://github.com - apiBaseUrl: https://api.github.com - token: ${GITHUB_TOKEN} ``` Locations point out the specific org(s) you want to import. The `type` of these locations must be `github-org`, and the `target` must point to the exact URL of -some organization. You can have several such location entries if you want, but -typically you will have just one. +some organization. You can have several such location entries if needed. -The processor itself is configured in the other block, under -`catalog.processors.githubOrg`. There may be many providers, each targeting a -specific `target` which is supposed to be the address of the home page of GitHub -or your GitHub Enterprise installation. - -The example above assumes that the backend is started with an environment -variable called `GITHUB_TOKEN` that contains a Personal Access Token. The token -needs to have at least the scopes `read:org`, `read:user`, and `user:email` in -the given `target`. - -If you want to address your own GitHub Enterprise instance, replace occurrences -of `https://github.com` in the configuration above with the address of your -GitHub Enterprise home page, and the `apiBaseUrl` to where your API endpoint -lives - commonly on the form `https:///api/v3`. +The authorization for loading org information comes from a configured +[GitHub integration](locations.md#configuration). When using a personal access +token, the token needs to have at least the scopes `read:org`, `read:user`, and +`user:email` in the given `target`.