Skip to content

Commit 452fed8

Browse files
committed
WIP
1 parent 7c08d09 commit 452fed8

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/github-app-setup.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This guide walks through creating and installing a GitHub App for github-ops-app
2828
> endpoint URL until after deployment. You'll configure and enable webhooks
2929
> in [Step 10](#step-10-configure-webhook).
3030
31-
## Step 2: Configure Permissions
31+
### Configure Permissions
3232

3333
Under **Permissions**, set the following:
3434

@@ -39,30 +39,30 @@ Under **Permissions**, set the following:
3939
| Contents | Read | Read branch protection rules |
4040
| Pull requests | Read | Access PR details for compliance |
4141

42-
### Organization Permissions
42+
#### Organization Permissions
4343

4444
| Permission | Access | Purpose |
4545
|----------------|------------|----------------------------------|
4646
| Members | Read/Write | Manage team membership |
4747
| Administration | Read | Read organization settings |
4848

49-
## Step 3: Subscribe to Events
49+
## Step 2: Subscribe to Events
5050

5151
Under **Subscribe to events**, check:
5252

5353
- [x] **Pull request** - PR open, close, merge events
5454
- [x] **Team** - Team creation, deletion, changes
5555
- [x] **Membership** - Team membership changes
5656

57-
## Step 4: Installation Settings
57+
## Step 3: Installation Settings
5858

5959
| Setting | Value |
6060
|-----------------------------------------|----------------------|
6161
| Where can this GitHub App be installed? | Only on this account |
6262

6363
Click **Create GitHub App**.
6464

65-
## Step 5: Generate Private Key
65+
## Step 4: Generate Private Key
6666

6767
After creating the app:
6868

@@ -72,13 +72,13 @@ After creating the app:
7272
4. This file is used for `APP_GITHUB_APP_PRIVATE_KEY` or
7373
`APP_GITHUB_APP_PRIVATE_KEY_PATH`
7474

75-
## Step 6: Note Your App ID
75+
## Step 5: Note Your App ID
7676

7777
On the app's settings page, find and save:
7878

7979
- **App ID** - numeric ID displayed near the top (e.g., `123456`)
8080

81-
## Step 7: Install the App
81+
## Step 6: Install the App
8282

8383
1. In the left sidebar, click **Install App**
8484
2. Select your organization
@@ -87,7 +87,7 @@ On the app's settings page, find and save:
8787
- **Only select repositories** - if limiting scope
8888
4. Click **Install**
8989

90-
## Step 8: Get Installation ID
90+
## Step 7: Get Installation ID
9191

9292
After installation, you'll be redirected to a URL like:
9393
```
@@ -103,7 +103,7 @@ curl -H "Authorization: Bearer YOUR_JWT" \
103103
https://api.github.com/app/installations
104104
```
105105

106-
## Step 9: Configure Environment Variables
106+
## Step 8: Configure Environment Variables
107107

108108
Set these environment variables in your deployment:
109109

@@ -126,7 +126,7 @@ APP_GITHUB_APP_PRIVATE_KEY_PATH=/path/to/private-key.pem
126126
APP_GITHUB_APP_PRIVATE_KEY=arn:aws:ssm:us-east-1:123456789:parameter/github-bot/private-key
127127
```
128128

129-
## Step 10: Configure Webhook
129+
## Step 9: Configure Webhook
130130

131131
After deploying your server, configure and enable webhooks:
132132

0 commit comments

Comments
 (0)