From 92b1bb4057855824cb02fb26346391e8a59a6fda Mon Sep 17 00:00:00 2001 From: blam Date: Tue, 26 Apr 2022 10:38:52 +0200 Subject: [PATCH] docs: rework the wording a ltitle bit Signed-off-by: blam --- docs/getting-started/configuration.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md index 4c8a65553f..9db1f7f958 100644 --- a/docs/getting-started/configuration.md +++ b/docs/getting-started/configuration.md @@ -203,7 +203,7 @@ could read: The GitHub integration supports loading catalog entities from GitHub or GitHub Enterprise. Entities can be added to static catalog configuration, registered with the catalog-import plugin, or discovered from a GitHub organization. Users -and Groups can also be loaded from an organization. While using GitHub Apps +and Groups can also be loaded from an organization. While using [GitHub Apps](../integrations/github/github-apps.md) might be the best way to set up integrations, for this tutorial you'll use a Personal Access Token. @@ -219,18 +219,29 @@ for 7 days, it's a lucky number. Set the scope to your likings. For this tutorial, selecting `repo` and `workflow` is required as the scaffolding job in this guide configures a GitHub actions workflow for the newly created project. -In the `app-config.yaml`, search for `integrations:` and add your token, like we -did in below example: +For this tutorial, we will be writing the token to `app-config.local.yaml`. This file might not exist for you, so if it doesn't go ahead and create it alongside the `app-config.yaml` at the root of the project. +This file should also be excluded in `.gitignore`, to avoid accidental committing of this file. + +In your `app-config.local.yaml` go ahead and add the following: ```yaml integrations: github: - host: github.com - token: $GITHUB_TOKEN + token: ghp_urtokendeinfewinfiwebfweb # this should be the token from GitHub ``` That's settled. This information will be leveraged by other plugins. +If you're looking for a more production way to manage this secret, then you can do the following with the token being stored in an environment variable called `GITHUB_TOKEN`. + +```yaml +integrations: + github: + - host: github.com + token: ${GITHUB_TOKEN} # this will use the environment variable GITHUB_TOKEN +``` + Some helpful links, for if you want to learn more about: - [Other available integrations](../integrations/)