wopr-plugin-github

GitHub integration for WOPR - webhooks, PR notifications, and repository management.

Prerequisites

• GitHub CLI (gh) installed and authenticated (gh auth login)
• wopr-plugin-tailscale-funnel for public webhook URLs
• WOPR webhooks extension configured

Installation

wopr plugin add wopr-network/wopr-plugin-github

Configuration

In your WOPR config (~/.wopr/config.json):

{
  "plugins": {
    "wopr-plugin-github": {
      "orgs": ["wopr-network"],
      "prReviewSession": "discord:misfits:#pay-no-attention-to-the-man-behind-the-curtain",
      "releaseSession": "discord:misfits:#releases"
    }
  }
}

Options

| Option | Type | Default | Description | |--------|------|---------|-------------| | orgs | array | [] | GitHub organizations to manage webhooks for | | prReviewSession | string | - | WOPR session to route PR events to | | releaseSession | string | - | WOPR session to route merge/release events to |

CLI Commands

# Check GitHub integration status
wopr github status

# Set up webhooks for all configured orgs
wopr github setup

# Set up webhook for a specific org
wopr github setup my-org

# Show webhook URL
wopr github url

Extension API

Other plugins can use the GitHub extension:

const github = ctx.getExtension("github") as GitHubExtension;

// Check if gh CLI is authenticated
const authed = await github.isAuthenticated();

// Get the webhook URL
const url = await github.getWebhookUrl();

// Set up webhook for an org
const result = await github.setupWebhook("my-org");
if (result.success) {
  console.log(`Webhook ID: ${result.webhookId}`);
  console.log(`URL: ${result.webhookUrl}`);
} else {
  console.error(result.error);
}

How It Works

1. Plugin uses gh CLI to interact with GitHub API
2. When setting up webhooks, it uses the funnel extension to get a public URL
3. Creates org-level webhooks that send PR and review events to WOPR
4. Events are routed to configured WOPR sessions for processing

Dependencies

This plugin works in conjunction with:

• wopr-plugin-tailscale-funnel - Provides public URLs via Tailscale Funnel
• WOPR webhooks extension - Routes incoming webhooks to sessions

Supported Events

Currently configured events:

• pull_request - PR opened, closed, merged, etc.
• pull_request_review - Reviews submitted

Integration with wopr-plugin-webhooks

For receiving GitHub webhooks without the built-in preset, you can configure a custom mapping in the webhooks plugin:

{
  "webhooks": {
    "mappings": [
      {
        "id": "github-events",
        "match": { "path": "github" },
        "action": "agent",
        "wakeMode": "now",
        "sessionKey": "discord:misfits:#my-channel",
        "messageTemplate": "GitHub {{action}}: PR #{{pull_request.number}} in {{repository.full_name}}: {{pull_request.title}}\nBy: {{pull_request.user.login}}\nURL: {{pull_request.html_url}}"
      }
    ]
  }
}

Important: Use action: "agent" with wakeMode: "now" instead of action: "wake" to return 202 Accepted immediately. GitHub webhooks expect fast responses and will timeout/retry if you use synchronous wake actions.

License

MIT