From 96224ad1582efe8af3ea72a97f042d0b1b05f7d5 Mon Sep 17 00:00:00 2001 From: Tim Hansen Date: Thu, 8 Apr 2021 11:07:23 -0600 Subject: [PATCH] Document create-github-app CLI command Signed-off-by: Tim Hansen --- docs/cli/commands.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/cli/commands.md b/docs/cli/commands.md index f5e63824a7..33693b010f 100644 --- a/docs/cli/commands.md +++ b/docs/cli/commands.md @@ -54,6 +54,8 @@ versions:check Check Backstage package versioning prepack Prepares a package for packaging before publishing postpack Restores the changes made by the prepack command +create-github-app Create new GitHub App in your organization (experimental) + help [command] display help for command ``` @@ -609,3 +611,18 @@ the resulting archive in the target `workspace-dir`. ```text Usage: backstage-cli build-workspace [options] <workspace-dir> ``` + +## create-github-app + +Scope: `root` + +Creates a GitHub App in your GitHub organization. This is an alternative to +token-based [GitHub integration](../integrations/github/locations.md). See +[GitHub Apps for Backstage Authentication](../plugins/github-apps.md). + +Launches a browser to create the App through GitHub and saves the result as a +YAML file that can be referenced in the GitHub integration configuration. + +```text +Usage: backstage-cli create-github-app <github-org> +```