Skip to content

Commit 3376299

Browse files
committed
Moved installing GitHub App to the end of INSTALL.md
1 parent fa4caff commit 3376299

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
@@ -57,23 +57,6 @@ Once it is created, you will need to download the private key.
5757
5858
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.
5959

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

7962
You need to create an Azure Function App, and deploy the Azure Function to it.
@@ -230,7 +213,7 @@ You can find the URL of the Function App in the Resources pane (under the correc
230213

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

233-
### Configuring the GitHub App
216+
## Configuring the GitHub App
234217

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

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

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

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

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

0 commit comments

Comments
 (0)