How It Works
Notra analyzes your repository activity and creates structured changelogs with intelligent categorization and prioritization.Connect Your Repository
Link your GitHub repository to Notra. The system will start tracking pull requests, commits, and releases.
Configure Your Schedule
Set up automatic changelog generation on a schedule (daily, weekly, or monthly) or trigger it manually based on events like releases.
AI Analyzes Activity
Notra’s AI agent examines your repository activity within the specified lookback window, categorizing changes by type and impact.
Changelog Structure
Every changelog follows a consistent, reader-friendly format:Summary
A concise overview (120-180 words) that captures the essence of what changed and why it matters.Highlights
Up to five most important changes, selected based on:- Security fixes and improvements
- Breaking changes
- Major new features
- Reliability and performance improvements
Highlights are filtered for high-signal updates with clear user impact. Low-impact maintenance work is automatically excluded.
More Updates
Remaining changes organized by category:- Security: Security patches and improvements
- Features & Enhancements: New capabilities and improvements
- Bug Fixes: Resolved issues
- Performance Improvements: Speed and efficiency gains
- Infrastructure: Backend and deployment changes
- Internal Changes: Refactoring and code quality
- Testing: Test coverage and quality improvements
- Documentation: Docs updates and additions
Lookback Windows
Control how far back Notra looks for changes when generating scheduled changelogs:| Window | Description | Best For |
|---|---|---|
current_day | Today’s changes only | Real-time daily updates |
yesterday | Previous day’s activity | Morning recaps |
last_7_days | Past week | Weekly team updates |
last_14_days | Past two weeks | Bi-weekly releases |
last_30_days | Past month | Monthly summaries |
For event-based triggers (like GitHub releases), Notra automatically determines the relevant timeframe by comparing the current release with the previous one.
Tone Customization
Choose the tone that matches your brand voice: Conversational (Default)Warm and authentic, like a founder sharing updates with the developer community. Professional
Polished and precise, ideal for enterprise audiences. Casual
Friendly and approachable, great for community-driven projects. Formal
Structured and technical, perfect for regulated industries.
Configuration Options
Output Settings
Customize how changelogs are generated:Source Configuration
Control what triggers changelog generation: Event-Based TriggersBest Practices
Write Meaningful PR Titles and Descriptions
Notra uses your PR titles and descriptions as source material. Clear, descriptive PRs lead to better changelogs. Good PR TitleAdd email verification flow with expiration handling
Poor PR TitleFix bug
Use Labels for Better Categorization
While Notra intelligently categorizes changes, GitHub labels help ensure accuracy:security: Security-related changesbreaking-change: Breaking changesenhancement: New featuresbug: Bug fixesperformance: Performance improvements
Set Appropriate Lookback Windows
Match your lookback window to your release cadence:- Ship daily? Use
yesterdayorcurrent_day - Weekly releases? Use
last_7_days - Monthly updates? Use
last_30_days
Review Before Publishing
All changelogs are created as drafts. Review them to:- Verify technical accuracy
- Add context that GitHub activity might not capture
- Adjust highlights for your audience
- Use the AI editor to refine specific sections
The AI editor can help you expand sections, adjust tone, or simplify technical language for non-technical readers.
Example Changelog
Here’s what a generated changelog looks like:Common Issues
Changelog is Too Short or Missing Expected Changes
Cause: Lookback window might not cover the relevant timeframe, or PRs lack sufficient detail. Solution:- Verify your lookback window settings match your release cadence
- Check that PRs have descriptive titles and descriptions
- Ensure PRs are merged (not just created) within the lookback period
Too Many Low-Impact Items in Highlights
Cause: Limited high-impact changes during the timeframe. Solution:- Notra automatically limits highlights to truly important changes
- If you see maintenance items in highlights, adjust your brand voice settings to be more selective
- Consider a longer lookback window to capture more significant work
Changes from Private Repositories Not Appearing
Cause: Missing or expired GitHub token. Solution:- Navigate to Integrations → GitHub
- Re-authenticate your GitHub connection
- Ensure the token has access to private repositories