Connecting GitHub to Herald
Last updated: April 2026
Connecting a repo
For public repos, paste the repo path (e.g. owner/repo) in Settings → Integrations. No OAuth dance — Herald reads publicly available PR data directly.
For private repos, you'll need a Team+ plan. Private repos authenticate via a share link, JWT token, or admin access to grant Herald read access to your merged PRs. See the Team plan for details.
Choosing a repo
After connecting, select which repo to link to your Herald project. One repo per project on Solo; multiple repos on Team+.
How PR sync works
Herald polls your connected repo periodically for merged PRs. Each merged PR appears in your Herald dashboard as a pending changelog item. You can also trigger a manual sync.
AI draft generation
When a PR is surfaced, Herald sends the PR title, body, and labels to an AI model that generates a changelog entry with a human-readable title, description paragraph, and suggested category (Feature, Fix, Improvement, Security). You can edit before publishing.
Category auto-detection
Herald maps labels automatically: bug → Fix, enhancement → Feature, security → Security. Custom mappings coming soon.
What makes a good PR for Herald
- Brief but descriptive PR titles
- Body that explains user-facing impact
- Labels matching your category mapping
BYOK self-hosting note
Self-hosted instances need their own OpenAI or Anthropic API key. Cloud plans include AI usage.
Next article Installing the Herald Widget