Changelog from PRs
Overview
Changelog from PRs turns your merged GitHub pull requests into a clean, shareable changelog. It automatically summarizes each merged PR, lets you tag entries for different audiences or categories, and gives you controls to edit, hide, copy, or export updates. It’s for anyone who needs to keep teammates and stakeholders up to date without reading every diff.
When to use it
- Share what changed in your repo after a sprint or release.
- Create audience-specific updates (e.g., Engineering, Product, Support).
- Prepare a weekly/monthly update you can paste into chat, email, or docs.
- Filter out noise and hide internal-only changes before sharing.
How to use it
- Open Dashboard → Changelog for your repository.
- Select a date range at the top to choose which merged PRs to include.
- Review AI‑summarized entries in the list. Each entry shows the PR title, merged date, and a short summary.
- Edit an entry by clicking Edit. Update the title or summary to match your voice, then click Save.
- Apply tags by clicking Tags on an entry. Choose one or more Audience and Category tags so teammates can filter. Click Done to apply.
- Hide noise by clicking Hide on any entry you don’t want in the shared view. Hidden items are excluded from copy and export.
- Filter the list using the Filters panel (e.g., Audience, Category, Author, or Status) to refine what will be shared.
- Preview the changelog with the Share Preview toggle to see exactly what others will receive.
- Copy updates by clicking Copy and choosing a preset (e.g., “All entries,” “Product update,” “Support notes”). The formatted text is placed on your clipboard.
- Export by clicking Export and selecting your preferred format (e.g., Markdown, CSV). The export includes only the visible, filtered entries.
- Share your copied or exported changelog with your team in your usual channels.
Options and settings
- Date range: Limits which merged PRs are included in the list and in any copy/export.
- Filters: Narrow entries by Audience, Category, Author, or Status (e.g., hidden/visible).
- Edit: Opens a summary editor for the selected entry; changes affect copy/export.
- Tags: Assign Audience and Category labels used by filters and presets.
- Hide/Unhide: Exclude or restore entries from the shared view.
- Share Preview: Shows the formatted output as others will see it.
- Copy presets: One-click formats for common audiences; respects filters and hidden items.
- Export: Download the current selection in a chosen format for archiving or sharing.
Tips
- Start by tagging a few representative entries; presets work best when entries have consistent Audience and Category tags.
- If an AI summary is off, edit it once—your changes are saved and used in future copies/exports.
- Use Hide for internal refactors or dependency bumps you don’t want to broadcast.
- Set the date range to the last sprint or release window to create focused updates fast.
Was this page helpful?
Let us know if you found what you were looking for.