Skip to content

Commit 3f9466c

Browse files
authored
Merge pull request #3 from advanced-security/github-app-install-readme
Moved installing GitHub App to the end of INSTALL.md
2 parents 8820721 + 3376299 commit 3f9466c

File tree

1 file changed

+16
-21
lines changed

1 file changed

+16
-21
lines changed

INSTALL.md

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -58,23 +58,6 @@ Once it is created, you will need to download the private key.
5858
5959
This is possible [using a manifest](https://docs.github.com/en/enterprise-cloud@latest/apps/sharing-github-apps/registering-a-github-app-from-a-manifest), but has not yet been implemented here.
6060

61-
## Installing the GitHub App
62-
63-
You need to install the GitHub App on an organization or repository.
64-
65-
### Use the GitHub UI to install the GitHub App
66-
67-
- navigate to the GitHub App you created earlier, and click on the "Install App" button
68-
- choose whether to install it for selected repositories, or for the whole organization
69-
70-
### Use the GitHub API to install the GitHub App
71-
72-
> **TODO**
73-
74-
This has not been implemented yet.
75-
76-
This is left until the creation of the app using a manifest has been implemented.
77-
7861
## Deploying the Azure Function
7962

8063
You need to create an Azure Function App, and deploy the Azure Function to it.
@@ -231,7 +214,7 @@ You can find the URL of the Function App in the Resources pane (under the correc
231214

232215
Open up the Function App, and expand the Functions node. Right-click on the Function, and select "Copy Function Url" from the context menu.
233216

234-
### Configuring the GitHub App
217+
## Configuring the GitHub App
235218

236219
Fill in the details you now know from the Function App and installed Function into the GitHub App's settings.
237220

@@ -240,8 +223,20 @@ Fill in the details you now know from the Function App and installed Function in
240223
- set the webhook URL to the URL of the Function
241224
- set the webhook to Active by checking the box
242225

243-
### Install the GitHub App on the organization or repositories
226+
## Installing the GitHub App
227+
228+
You need to install the GitHub App on an organization or repository.
229+
230+
### Use the GitHub UI to install the GitHub App
244231

245-
You can now install the GitHub App on the organization or repositories you want to receive secret scanning notifications for.
232+
- navigate to the GitHub App you created earlier, and click on the "Install App" button
233+
- choose which organization to install it on
234+
- choose whether to install it for selected repositories, or for the whole organization
246235

247-
In the App settings, choose "Install App" and follow the prompts for the organization you want to install the App on.
236+
### Use the GitHub API to install the GitHub App
237+
238+
> **TODO**
239+
240+
This has not been implemented yet.
241+
242+
This is left until the creation of the app using a manifest has been implemented.

0 commit comments

Comments
 (0)