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. Choose the customer tone in your repository settings.
3. Publish a Release
Recent releases are imported when you connect a repository. You can also publish a new release on GitHub. Generate notes, review each audience, and publish when you are ready. Enable automatic generation and publishing in repository settings when you want to automate this flow.
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 review notes before publishing?
Yes. Keep auto-publish off in repository settings, edit the generated notes for each audience, and publish after review. You can also adjust the customer tone before regenerating.
How do I share my changelog?
Enable a public changelog in repository settings, then use View Changelog on the repository page to open and share its link. Only published releases appear on that page.