Connect GitHub

Connect your GitHub repositories to paplix for automatic conflict detection.

Prerequisites

  • A GitHub account
  • At least one repository containing KiCad files

Connect Your Account

  1. Go to Settings
  2. In the "Connected Accounts" section, click "Connect" next to GitHub
  3. Authorize paplix to access your repositories

Permissions Required

paplix requests the following GitHub permissions:

| Permission | Purpose | |------------|---------| | read:user | Read your GitHub profile | | user:email | Access your email for notifications | | repo | Access repositories to read files and create webhooks |

Add a Repository

After connecting your account:

  1. Go to Repositories
  2. Click "Connect Repository"
  3. You'll see a list of your GitHub repositories
  4. Select one or more repositories to monitor
  5. Click "Connect"

Webhook Configuration

When you connect a repository, paplix automatically creates a webhook that listens for:

  • Push events - Detects when KiCad files are modified
  • Pull request events - Detects new and updated pull requests

Webhook Security

  • Each webhook uses a unique secret for signature verification
  • All webhook payloads are verified before processing
  • HTTPS is required for all communications

Troubleshooting

Can't see your repositories?

Make sure you've granted paplix access to the repositories you want to connect. You may need to:

  1. Go to GitHub Settings > Applications
  2. Find "paplix" in the list
  3. Click "Configure"
  4. Grant access to additional repositories

Webhook not working?

Check the webhook status in your repository settings:

  1. Go to your repository on GitHub
  2. Click "Settings" > "Webhooks"
  3. Find the paplix webhook
  4. Check the "Recent Deliveries" tab for errors