blob: 807f1da8384256ca62a542eb75dfe19ccac0a0cc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
# Bot `bot/`
> **Type**: Cloudflare Worker
> **Platform**: Cloudflare Workers
> **Purpose**: PR Automation & Labeling
> **Latest Version**: 0.0.5-1
---
## Overview
The ProjT Launcher bot is a Cloudflare Worker that automates pull request labeling based on changed files. It listens for GitHub webhook events and applies appropriate labels automatically.
---
## Features
| Feature | Description |
|---------|-------------|
| **Auto-labeling** | Labels PRs based on file changes |
| **Path mapping** | Configurable path-to-label rules |
| **Webhook integration** | GitHub webhook receiver |
| **Zero cold start** | Cloudflare Workers edge deployment |
---
## Architecture
```
┌─────────────┐ ┌──────────────────┐ ┌─────────────┐
│ GitHub │────▶│ Cloudflare │────▶ │ GitHub │
│ Webhook │ │ Worker (bot/) │ │ API │
└─────────────┘ └──────────────────┘ └─────────────┘
│
┌──────▼────────┐
│ wrangler.json │
│ (config) │
└───────────────┘
```
---
## File Structure
```
bot/
├── index.js # Main worker logic
├── server.js # Local development server
├── package.json # Dependencies
└── wrangler.json # Cloudflare configuration
```
---
## Label Rules
The bot applies labels based on changed file paths:
| Path Pattern | Label |
|--------------|-------|
| `launcher/**` | `launcher` |
| `buildconfig/**` | `build` |
| `cmake/**` | `build` |
| `.github/workflows/**` | `ci` |
| `docs/**` | `documentation` |
| `zlib/**` | `library: zlib` |
| `bzip2/**` | `library: bzip2` |
| `quazip/**` | `library: quazip` |
| `cmark/**` | `library: cmark` |
| `tomlplusplus/**` | `library: toml++` |
| `libqrencode/**` | `library: qrencode` |
| `website/**` | `website` |
---
## Configuration
### wrangler.json
```json
{
"name": "projtlauncher-bot",
"main": "index.js",
"compatibility_date": "2024-01-01",
"vars": {
"GITHUB_APP_ID": "your-app-id"
}
}
```
### Environment Variables
| Variable | Description |
|----------|-------------|
| `GITHUB_APP_ID` | GitHub App ID |
| `GITHUB_APP_PRIVATE_KEY` | GitHub App private key |
| `GITHUB_WEBHOOK_SECRET` | Webhook signature secret |
---
## Development
### Prerequisites
- Node.js 18+
- Wrangler CLI (`npm install -g wrangler`)
- Cloudflare account
### Local Development
```bash
cd bot
npm install
# Start local dev server
npm run dev
# or
wrangler dev
```
### Testing Webhooks Locally
Use [smee.io](https://smee.io/) or ngrok to forward webhooks:
```bash
# Install smee client
npm install -g smee-client
# Forward webhooks
smee -u https://smee.io/your-channel -t http://localhost:8787
```
---
## Deployment
### Deploy to Cloudflare
```bash
cd bot
wrangler publish
```
### GitHub Webhook Setup
1. Go to repository Settings → Webhooks
2. Add webhook:
- **Payload URL**: `https://your-worker.workers.dev/webhook`
- **Content type**: `application/json`
- **Secret**: Your `GITHUB_WEBHOOK_SECRET`
- **Events**: Pull requests
---
## API Endpoints
| Endpoint | Method | Description |
|----------|--------|-------------|
| `/` | GET | Health check |
| `/webhook` | POST | GitHub webhook receiver |
---
## Security
- ✅ **Signature verification** — HMAC-SHA256 webhook signatures
- ✅ **App authentication** — GitHub App JWT tokens
- ✅ **Secret management** — Cloudflare Workers secrets
---
## Troubleshooting
### Bot not labeling PRs
1. Check Cloudflare Workers logs
2. Verify webhook delivery in GitHub settings
3. Ensure secrets are configured correctly
### Labels not created
Labels must exist in the repository before the bot can apply them.
---
## Related Documentation
- [CI Workflows](./workflows.md) — GitHub Actions integration
- [GitHub Scripts](./ptcigh.md) — Additional automation
---
## External Links
- [Cloudflare Workers Docs](https://developers.cloudflare.com/workers/)
- [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/)
- [GitHub Apps](https://docs.github.com/en/apps)
- [GitHub Webhooks](https://docs.github.com/en/webhooks)
|
