Releasebot

Configuration

Customize how Releasebot generates changelogs for your repositories.

Releasebot provides several configuration options to customize how changelogs are generated for your repositories.

Repository Settings

Each repository has its own settings that control changelog generation.

Tracked Branches

By default, Releasebot tracks the main branch. You can configure which branches trigger changelog generation:

  1. Go to your repository in the Releasebot dashboard
  2. Click "Settings"
  3. Under "Tracked Branches", add or remove branches

Common configurations:

  • Single branch: Track only main for production releases
  • Multiple branches: Track main and staging for different environments

Changelog Visibility

Control who can view your public changelog page:

  • Public - Anyone with the URL can view
  • Private - Only authenticated team members

Generation Settings

Change Type Detection

Releasebot automatically categorizes changes based on PR content:

TypeDescriptionExamples
featureNew functionality"Add user authentication"
fixBug fixes"Fix login redirect loop"
improvementEnhancements"Improve search performance"
breakingBreaking changes"Remove deprecated API endpoints"
docsDocumentation"Update API documentation"
choreMaintenance"Update dependencies"

Title Generation

The AI generates concise titles from your PR content. Tips for better titles:

  • Use clear, descriptive PR titles
  • Include context in PR descriptions
  • Use conventional commit messages

Customization

Excluding PRs

Some PRs shouldn't generate changelog entries. Add labels to exclude them:

  • no-changelog - Skip changelog generation
  • internal - Internal changes only
  • dependencies - Dependency updates

Custom Categories

Enterprise plans support custom change type categories. Contact support to configure custom categories for your organization.

Best Practices

PR Descriptions

For best results, include in your PR descriptions:

  • What changed (the feature or fix)
  • Why it was needed (the motivation)
  • How users are affected (if applicable)

Commit Messages

While we primarily use PR content, good commit messages help:

  • Use the imperative mood ("Add feature" not "Added feature")
  • Keep the first line under 50 characters
  • Add details in the body if needed

Review Before Publishing

All changelog entries are initially set to "draft" status. Review them before publishing to ensure accuracy.