paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 39 Packages Projects Releases Wiki Activity

Merge pull request #4549 from backstage/adamdmharvey-patch-2

Browse Source 
docs: Editorial changes to the GitHub App page
This commit is contained in:
Ben Lambert
2021-02-16 15:43:23 +01:00
committed by GitHub
parent 7ea855c3e2 633416f5e6
commit 0ca9559167
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/plugins/github-apps.md
+11 -11
View File
@@ -27,17 +27,17 @@ to grant the app more permissions if needed.
### Using the CLI (public GitHub only)
You can use the `backstage-cli` to create GitHub App' using a manifest file that
we provide. This gives us a way to automate some of the work required to create
a GitHub app.
You can use the `backstage-cli` to create a GitHub App using a manifest file
that we provide. This gives us a way to automate some of the work required to
create a GitHub app.
You can read more about the `backstage-cli create-github-app` method
[here](../cli/commands.md#create-github-app)
You can read more about the
[`backstage-cli create-github-app` method](../cli/commands.md#create-github-app).
Once you've gone through the CLI command, it should produce a `yaml` file in the
Once you've gone through the CLI command, it should produce a YAML file in the
root of the project which you can then use as an `include` in your
`app-config.yaml`. You can go ahead and skip to
[here](#including-in-integrations-config) if you've got to this part.
`app-config.yaml`. You can go ahead and
[skip ahead](#including-in-integrations-config) if you've already got an app.
### GitHub Enterprise
@@ -46,9 +46,9 @@ You have to create the GitHub Application manually using these
as GitHub Enterprise does not support creation of apps from manifests.
Once the application is created you have to generate a private key for the
application it in a `yaml` file.
application and place it in a YAML file.
The yaml file must include the following information. Please note that the
The YAML file must include the following information. Please note that the
indentation for the `privateKey` is required.
```yaml
@@ -64,7 +64,7 @@ privateKey: |
### Including in Integrations Config
Once the credentials are stored in a yaml file generated by `create-github-app`
Once the credentials are stored in a YAML file generated by `create-github-app`,
or manually by following the [GitHub Enterprise](#gitHub-enterprise)
instructions, they can be included in the `app-config.yaml` under the
`integrations` section.