Skip to content

Commit 7c08d09

Browse files
committed
wip
1 parent 08e1fa7 commit 7c08d09

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

docs/github-app-setup.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ This guide walks through creating and installing a GitHub App for github-ops-app
55
## Prerequisites
66

77
- GitHub organization with admin access
8-
- Webhook endpoint URL (your deployed server or Lambda API Gateway URL)
98

109
## Step 1: Create the GitHub App
1110

@@ -17,17 +16,17 @@ This guide walks through creating and installing a GitHub App for github-ops-app
1716

1817
3. Fill in the basic information:
1918

20-
| Field | Value |
21-
|--------------------|-----------------------------------------------------------|
22-
| GitHub App name | `github-ops-app` (must be unique across GitHub) |
23-
| Homepage URL | Your organization's URL or repo URL |
24-
| Webhook URL | Your endpoint (e.g., `https://api.example.com/webhooks`) |
25-
| Webhook secret | Generate a strong secret (save this for later) |
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 |
2626

27-
Generate a webhook secret:
28-
```bash
29-
openssl rand -hex 32
30-
```
27+
> **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).
3130
3231
## Step 2: Configure Permissions
3332

@@ -127,6 +126,18 @@ APP_GITHUB_APP_PRIVATE_KEY_PATH=/path/to/private-key.pem
127126
APP_GITHUB_APP_PRIVATE_KEY=arn:aws:ssm:us-east-1:123456789:parameter/github-bot/private-key
128127
```
129128

129+
## Step 10: Configure Webhook
130+
131+
After deploying your server, configure and enable webhooks:
132+
133+
1. Go to your GitHub App settings:
134+
`https://github.com/organizations/YOUR_ORG/settings/apps/YOUR_APP`
135+
2. Set **Webhook URL** to your endpoint:
136+
- Lambda: `https://xxx.execute-api.region.amazonaws.com/webhooks`
137+
- Server: `https://your-domain.com/webhooks`
138+
3. Check **Active** to enable webhooks
139+
4. Click **Save changes**
140+
130141
## Using the App Manifest (Alternative)
131142

132143
For automated setup, use the manifest at `assets/github/manifest.json`:

0 commit comments

Comments
 (0)