Merge pull request #5262 from backstage/timbonicus/github-app-cli

Document create-github-app CLI command
2021-04-09 14:37:35 +02:00
parent 69043d39b7 96224ad158
commit d86ba19c31
1 changed files with 17 additions and 0 deletions
@@ -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] &lt;workspace-dir&gt;
 ```
+
+## 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 &lt;github-org&gt;
+```