You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: INSTALL.md
+16-21Lines changed: 16 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,23 +57,6 @@ Once it is created, you will need to download the private key.
57
57
58
58
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.
59
59
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
-
77
60
## Deploying the Azure Function
78
61
79
62
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
230
213
231
214
Open up the Function App, and expand the Functions node. Right-click on the Function, and select "Copy Function Url" from the context menu.
232
215
233
-
###Configuring the GitHub App
216
+
## Configuring the GitHub App
234
217
235
218
Fill in the details you now know from the Function App and installed Function into the GitHub App's settings.
236
219
@@ -239,8 +222,20 @@ Fill in the details you now know from the Function App and installed Function in
239
222
- set the webhook URL to the URL of the Function
240
223
- set the webhook to Active by checking the box
241
224
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
243
230
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
245
234
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