Skip to content

Commit e31ddba

Browse files
heiskrrsese
andauthored
Expand README for src/webhooks (#58905)
Co-authored-by: Robert Sese <734194+rsese@users.noreply.github.com>
1 parent 933c270 commit e31ddba

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

src/webhooks/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,37 @@ Slack: `#docs-engineering`
5757
Repo: `github/docs-engineering`
5858

5959
If you have a question about the webhooks pipeline, you can ask in the `#docs-engineering` Slack channel. If you notice a problem with the webhooks pipeline, you can open an issue in the `github/docs-engineering` repository.
60+
61+
## Ownership & Escalation
62+
63+
### Ownership
64+
- **Team**: Docs Engineering
65+
- **Source data**: API Platform (github/rest-api-description)
66+
67+
### Escalation path
68+
1. **Pipeline failures** → #docs-engineering Slack
69+
2. **OpenAPI schema issues** → #api-platform Slack
70+
3. **Production incidents** → #docs-engineering
71+
72+
### On-call procedures
73+
If the webhooks pipeline fails:
74+
1. Check workflow logs in `.github/workflows/sync-openapi.yml`
75+
2. Verify access to `github/rest-api-description` repo
76+
3. Check for OpenAPI schema validation errors
77+
4. Review changes in generated data files
78+
5. Check `config.json` SHA tracking
79+
6. Escalate to API Platform team if schema issue
80+
81+
### Monitoring
82+
- Pipeline runs automatically on daily schedule (shared with REST/GitHub Apps)
83+
- PRs created with `github-openapi-bot` label
84+
- SHA tracking in `config.json` for version history
85+
- Failures visible in GitHub Actions
86+
87+
This pipeline is in maintenance mode. We will continue to support ongoing improvements incoming from the platform but we are not expecting new functionality moving forward.
88+
89+
### Known limitations
90+
- **Shared pipeline** - Cannot run webhooks independently of REST/GitHub Apps
91+
- **Single page** - All events on one page (may impact performance)
92+
- **Introduction placement** - Manual content must be at start of file
93+
- **Payload complexity** - Some payloads are very large and complex

0 commit comments

Comments
 (0)