⚡ docsfy

github-webhook-server

Keep GitHub pull requests moving with automated checks, approvals, labels, cherry-picks, and release workflows.

Get Started →

Getting Started

  • Start Automating a Repository

    Set up the server, add the minimal data directory and config, connect one repository, and verify the webhook is live in minutes.

Explore →

User Guides

  • Configure Repositories

    Add repositories, choose global defaults, apply per-repo overrides, and let repository maintainers customize behavior safely.

  • Set Up OWNERS and Review Rules

    Create OWNERS files, define approvers and reviewers, and control who can run PR commands or be auto-assigned to changes.

  • Manage Pull Requests

    Learn what the server does automatically on PR open, review, sync, and merge so contributors understand labels, checks, approvals, and merge readiness.

  • Run Pull Request Commands

    Use slash commands to retest checks, approve work, assign reviewers, rebase branches, cherry-pick changes, and recover missed automation.

  • Set Up Checks and Release Workflows

    Configure tox, pre-commit, custom check runs, container builds, and PyPI publishing so PRs and tags trigger the right automation.

  • Enable AI Features

    Turn on conventional title suggestions, AI-assisted cherry-pick conflict resolution, and test-oracle recommendations with the sidecar and provider settings.

  • Secure Webhooks and Pull Requests

    Protect incoming webhooks and PR automation with secrets, IP allowlists, suspicious-path detection, committer identity checks, and trusted-network-only access.

  • Debug with the Log Viewer

    Open live and historical webhook logs, trace PR flow by delivery ID, and inspect step-level failures when automation does not behave as expected.

Explore →

Recipes

  • Automate Common Maintainer Tasks

    Copy working patterns for common setups like draft-PR command exceptions, protected branches, repo-local overrides, release-branch cherry-picks, and custom label policies.

Explore →

Reference

  • Configuration Reference

    Look up every supported `config.yaml` and `.github-webhook-server.yaml` key, including defaults, repository overrides, and validation rules.

  • Environment Variables

    Find every environment variable that affects startup, logging, sidecar behavior, log viewer exposure, and MCP availability.

  • Webhook and Health API

    Check the exact webhook callback path, health endpoint behavior, security headers, and what a successful HTTP response really means.

  • Log Viewer and MCP API

    Look up the `/logs` HTTP and WebSocket endpoints plus the optional `/mcp` endpoint when you need exact routes, parameters, and response shapes.

  • Supported GitHub Events

    See which GitHub events trigger automation, which ones are skipped intentionally, and how each event maps to server behavior.

Explore →
🤖
AI-friendly documentation

This documentation is optimized for AI consumption.