Skip to main content

GitHub Integration

Connect Erold with GitHub to automatically sync issues, link PRs to tasks, and automate workflows.

Features

  • PR Linking - Automatically link pull requests to tasks
  • Status Updates - Update task status when PRs are merged
  • Branch Detection - Detect task IDs in branch names
  • Commit Tracking - Track commits that reference tasks

Setup

1. Connect GitHub

  1. Go to Settings → Integrations in Erold
  2. Click "Connect GitHub"
  3. Authorize Erold to access your repositories
  4. Select which repositories to connect

2. Configure Webhooks

Erold automatically configures webhooks for connected repositories. Events monitored:

  • Pull request opened/closed/merged
  • Push events (for commit tracking)
  • Branch created/deleted

Linking Tasks to PRs

Via Branch Name

Include the task ID in your branch name:

git checkout -b MYAPP-45-fix-timeout
git checkout -b feature/MYAPP-45
git checkout -b MYAPP-45

Via PR Title or Description

Reference the task ID in your PR:

# PR Title
MYAPP-45: Fix database timeout

# Or in description
This PR fixes the timeout issue.
Closes MYAPP-45

Via Commit Message

git commit -m "MYAPP-45: Increase pool size to 20"

Automatic Status Updates

Configure automatic task status changes:

GitHub Event Task Status
PR Opened In Review (optional)
PR Merged Done
PR Closed (not merged) No change

Configure in Settings → Integrations → GitHub → Status Mapping

GitHub Actions

Use Erold in your CI/CD workflows:

# .github/workflows/yet.yml
name: Update Erold

on:
  pull_request:
    types: [closed]

jobs:
  update-task:
    if: github.event.pull_request.merged == true
    runs-on: ubuntu-latest
    steps:
      - name: Extract task ID
        id: task
        run: |
          TASK_ID=$(echo "${{ github.head_ref }}" | grep -oE '[A-Z]+-[0-9]+' | head -1)
          echo "task_id=$TASK_ID" >> $GITHUB_OUTPUT

      - name: Update task status
        if: steps.task.outputs.task_id
        run: |
          curl -X PATCH https://api.erold.dev/v1/tasks/${{ steps.task.outputs.task_id }} \
            -H "Authorization: Bearer ${{ secrets.EROLD_API_KEY }}" \
            -H "Content-Type: application/json" \
            -d '{"status": "done"}'

Creating Tasks from Issues

Optionally sync GitHub Issues to Erold tasks:

  1. Go to Settings → Integrations → GitHub
  2. Enable "Sync Issues"
  3. Select which labels to sync

New GitHub issues with selected labels automatically create Erold tasks.

Activity Feed

GitHub activity appears in the Erold activity feed:

  • Commits linked to tasks
  • PRs opened/merged
  • Branches created for tasks

Disconnecting

  1. Go to Settings → Integrations
  2. Find GitHub and click "Disconnect"
  3. Confirm disconnection

Existing task links remain but no new updates will sync.

Troubleshooting

PRs not linking

  • Check task ID format matches exactly (e.g., MYAPP-45)
  • Verify webhook is configured in GitHub repo settings
  • Check webhook delivery logs in GitHub

Status not updating

  • Verify status mapping is configured
  • Check the task exists and isn't archived

Next Steps