GitHub Integration

Automatically generate changelogs from your GitHub commits

GitHub Integration

Automatically generate changelogs from your GitHub repository commits using AI.

What you'll get

  • AI-powered changelog generation using GPT-4
  • Real-time webhook integration with signature verification
  • Automatic notifications via Slack and Discord
  • Conventional commit support

Setup

Step 1: Connect your repository

  1. Go to your Saylo dashboard
  2. Navigate to Settings → Integrations
  3. Find the GitHub card and click Connect
  4. You'll be redirected to GitHub's authorization page
  5. Click Authorize Saylo to grant access
  6. Select the repository you want to connect
  7. Click Connect Repository

Step 2: Configure settings

  1. Choose your preferences:
    • Auto-publish: Automatically publish changelogs or save as drafts
    • Slack notifications: Send notifications to your Slack workspace
    • Discord notifications: Send notifications to your Discord channel
  2. Click Save Configuration

Step 3: Test the integration

  1. Make a test commit to your connected repository
  2. Push the commit to the main/master branch
  3. Wait 1-2 minutes for processing
  4. Check your Saylo dashboard for the new changelog entry

How it works

AI analysis process

When you push commits to your repository:

  1. GitHub webhook sends push event to Saylo
  2. System retrieves commit details and file changes
  3. AI analyzes commit messages and file diffs
  4. Changes are categorized (features, bug fixes, improvements)
  5. Professional changelog content is generated using GPT-4
  6. Changelog image is created using DALL-E
  7. Entry is saved to database with metadata

Supported commit formats

Conventional Commits (Recommended):

feat: add new feature
fix: resolve bug
docs: update documentation
style: formatting changes
refactor: code restructuring

Traditional Commits:

Add user authentication
Fix login bug
Update README
Improve performance

Configuration options

Auto-publish settings

  • Enable/Disable: Turn auto-generation on or off
  • Draft Mode: Create changelogs as drafts for review
  • Version Detection: Auto-detect version numbers from tags

Commit filtering

  • Include Types: Select which commit types to include
  • Exclude Patterns: Exclude commits matching certain patterns
  • Minimum Impact: Only include commits with significant changes

Notifications

  • Slack: Send notifications to your Slack workspace
  • Discord: Send notifications to your Discord channel
  • Email: Receive email notifications for new changelogs

Examples

Feature commit

Commit: feat: add dark mode support Generated Entry: ✨ Added dark mode support for improved user experience

Bug fix commit

Commit: fix: resolve mobile navigation issue Generated Entry: 🐛 Fixed mobile navigation menu not displaying correctly

Performance improvement

Commit: perf: optimize database queries Generated Entry: ⚡ Improved application performance with optimized database queries

Best practices

Commit messages

  • Use conventional commit format for better categorization
  • Write clear, descriptive commit messages
  • Include issue numbers when relevant
  • Use present tense ("add" not "added")
  • Focus on user-facing changes

Branch strategy

  • Connect your main/master branch for production releases
  • Use feature branches for development
  • Merge to main when ready for release

Troubleshooting

Webhook not receiving events?

  • Check that you're pushing to the connected branch (main/master)
  • Verify the webhook is active in your GitHub repository settings
  • Check GitHub's webhook delivery logs for failed attempts
  • Ensure your repository is public or Saylo has access

OAuth authentication issues?

  • Check that your GitHub OAuth app is properly configured
  • Verify the callback URL matches exactly
  • Ensure you have admin access to the repository
  • Try disconnecting and reconnecting the integration

Changelog not generating?

  • Verify that commits follow conventional format
  • Check that the repository is properly connected
  • Look for any error messages in your Saylo dashboard
  • Ensure OpenAI API key is configured and valid

Security

  • GitHub OAuth 2.0 authentication
  • Minimal required permissions
  • Secure token storage
  • HMAC-SHA256 signature verification for webhooks

Need help?

  • Check the GitHub repository for known issues
  • Review the Saylo documentation
  • Contact support with specific error messages and logs
  • Check webhook delivery logs in your GitHub repository settings

View All Integrations