Skip to content

Commit 5745a21

Browse files
committed
WIP
1 parent dde7928 commit 5745a21

File tree

1 file changed

+26
-35
lines changed

1 file changed

+26
-35
lines changed

docs/github-app-setup.md

Lines changed: 26 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -16,41 +16,32 @@ This guide walks through creating and installing a GitHub App for github-ops-app
1616

1717
3. Fill in the basic information:
1818

19-
| Field | Value |
20-
|-----------------------|-------------------------------------------------|
21-
| GitHub App name | `github-ops-app` (must be unique across GitHub) |
22-
| Homepage URL | Your organization's URL or repo URL |
23-
| Webhook > Webhook URL | Leave blank for now |
24-
| Webhook > Secret | Generate a strong secret (save this for later) |
25-
| Webhook > Active | **Uncheck** to disable webhooks initially |
26-
27-
> **Note**: Disable webhooks during creation since you may not know your
28-
> endpoint URL until after deployment. You'll configure webhooks and
29-
> subscribe to events in [Step 7](#step-7-configure-webhook-and-events).
30-
31-
### Configure Permissions
32-
33-
Under **Permissions**, set the following:
34-
35-
### Repository Permissions
36-
37-
| Permission | Access | Purpose |
38-
|---------------|--------|--------------------------------------|
39-
| Contents | Read | Read branch protection rules |
40-
| Pull requests | Read | Access PR details for compliance |
41-
42-
#### Organization Permissions
43-
44-
| Permission | Access | Purpose |
45-
|----------------|------------|----------------------------------|
46-
| Members | Read/Write | Manage team membership |
47-
| Administration | Read | Read organization settings |
48-
49-
4. Set installation scope:
50-
51-
| Setting | Value |
52-
|-----------------------------------------|----------------------|
53-
| Where can this GitHub App be installed? | Only on this account |
19+
| Field | Value |
20+
|-----------------------|-------------------------------------------------|
21+
| GitHub App name | `github-ops-app` (must be unique across GitHub) |
22+
| Homepage URL | Your organization's URL or repo URL |
23+
| Webhook > Webhook URL | Leave blank for now |
24+
| Webhook > Secret | Generate a strong secret (save this for later) |
25+
| Webhook > Active | **Uncheck** to disable webhooks initially |
26+
27+
> **Note**: Disable webhooks during creation since you may not know your
28+
> endpoint URL until after deployment. You'll configure webhooks and
29+
> subscribe to events in [Step 7](#step-7-configure-webhook-and-events).
30+
31+
4. Under **Permissions**, set the following:
32+
- Repository Permissions
33+
- Contents: Read
34+
- Read branch protection rules
35+
- Pull requests: Read
36+
- Access PR details for compliance
37+
- Organization Permissions
38+
- Administration: Read
39+
- Read organization settings
40+
- Members: Read/Write
41+
- Manage team membership
42+
43+
4. Under Set installation scope:
44+
- Where can this GitHub App be installed?: Only on this account
5445

5546
5. Click **Create GitHub App**
5647

0 commit comments

Comments
 (0)