@@ -25,8 +25,8 @@ This guide walks through creating and installing a GitHub App for github-ops-app
2525 | Webhook > Active | ** Uncheck** to disable webhooks initially |
2626
2727 > ** Note** : Disable webhooks during creation since you may not know your
28- > endpoint URL until after deployment. You'll configure and enable webhooks
29- > in [ Step 10 ] ( #step-10 -configure-webhook ) .
28+ > endpoint URL until after deployment. You'll configure webhooks and
29+ > subscribe to events in [ Step 7 ] ( #step-7 -configure-webhook-and-events ) .
3030
3131### Configure Permissions
3232
@@ -46,23 +46,15 @@ Under **Permissions**, set the following:
4646| Members | Read/Write | Manage team membership |
4747| Administration | Read | Read organization settings |
4848
49- ## Step 2: Subscribe to Events
49+ 4 . Set installation scope:
5050
51- Under ** Subscribe to events** , check:
51+ | Setting | Value |
52+ | -----------------------------------------| ----------------------|
53+ | Where can this GitHub App be installed? | Only on this account |
5254
53- - [x] ** Pull request** - PR open, close, merge events
54- - [x] ** Team** - Team creation, deletion, changes
55- - [x] ** Membership** - Team membership changes
55+ 5 . Click ** Create GitHub App**
5656
57- ## Step 3: Installation Settings
58-
59- | Setting | Value |
60- | -----------------------------------------| ----------------------|
61- | Where can this GitHub App be installed? | Only on this account |
62-
63- Click ** Create GitHub App** .
64-
65- ## Step 4: Generate Private Key
57+ ## Step 2: Generate Private Key
6658
6759After creating the app:
6860
@@ -72,13 +64,13 @@ After creating the app:
72644 . This file is used for ` APP_GITHUB_APP_PRIVATE_KEY ` or
7365 ` APP_GITHUB_APP_PRIVATE_KEY_PATH `
7466
75- ## Step 5 : Note Your App ID
67+ ## Step 3 : Note Your App ID
7668
7769On the app's settings page, find and save:
7870
7971- ** App ID** - numeric ID displayed near the top (e.g., ` 123456 ` )
8072
81- ## Step 6 : Install the App
73+ ## Step 4 : Install the App
8274
83751 . In the left sidebar, click ** Install App**
84762 . Select your organization
@@ -87,7 +79,7 @@ On the app's settings page, find and save:
8779 - ** Only select repositories** - if limiting scope
88804 . Click ** Install**
8981
90- ## Step 7 : Get Installation ID
82+ ## Step 5 : Get Installation ID
9183
9284After installation, you'll be redirected to a URL like:
9385```
@@ -103,7 +95,7 @@ curl -H "Authorization: Bearer YOUR_JWT" \
10395 https://api.github.com/app/installations
10496```
10597
106- ## Step 8 : Configure Environment Variables
98+ ## Step 6 : Configure Environment Variables
10799
108100Set these environment variables in your deployment:
109101
@@ -126,7 +118,7 @@ APP_GITHUB_APP_PRIVATE_KEY_PATH=/path/to/private-key.pem
126118APP_GITHUB_APP_PRIVATE_KEY=arn:aws:ssm:us-east-1:123456789:parameter/github-bot/private-key
127119```
128120
129- ## Step 9 : Configure Webhook
121+ ## Step 7 : Configure Webhook and Events
130122
131123After deploying your server, configure and enable webhooks:
132124
@@ -138,6 +130,13 @@ After deploying your server, configure and enable webhooks:
1381303 . Check ** Active** to enable webhooks
1391314 . Click ** Save changes**
140132
133+ 5 . Under ** Subscribe to events** , check:
134+ - [x] ** Pull request** - PR open, close, merge events
135+ - [x] ** Team** - Team creation, deletion, changes
136+ - [x] ** Membership** - Team membership changes
137+
138+ 6 . Click ** Save changes**
139+
141140## Using the App Manifest (Alternative)
142141
143142For automated setup, use the manifest at ` assets/github/manifest.json ` :
0 commit comments