Documentation
Everything you need to get started with ShipLog.
Getting Started
1. Connect Your GitHub Repository
Click "Connect GitHub" and authorize ShipLog to access your repositories. Select the repos you want to generate release notes for.
2. Configure Audiences
By default, ShipLog generates notes for three audiences: Developers, Customers, and Stakeholders. Pro users can create custom audiences with tailored prompts.
3. Publish a Release
When you create a release on GitHub, ShipLog automatically generates release notes for each configured audience. View and edit them in your dashboard.
Features
GitHub Integration
Automatically triggered when you publish a release. Works with public and private repos.
Multiple Audiences
Generate different notes for developers, customers, and stakeholders from the same release.
Slack & Discord
Set up webhooks to automatically post release notes to your team channels.
AI-Powered
Uses advanced AI to analyze your commits and PRs, generating human-readable summaries.
FAQ
How does ShipLog work?
When you publish a GitHub release, ShipLog receives a webhook, analyzes the commits and PRs since the last release, and uses AI to generate audience-appropriate summaries.
What AI model do you use?
We use GPT-4o-mini for fast, cost-effective generation. The model is optimized for understanding code changes and producing clear, concise release notes.
Can I customize the prompts?
Pro and Team users can create custom audiences with their own prompts, allowing you to tailor the output for specific use cases like investor updates or support docs.
How do I share my changelog?
Each repo has a public changelog page at shiplog.io/c/your-repo. You can share this link, embed it on your site, or use our API to build custom integrations.