Changelog from PRs
Overview
Changelog from PRs builds a shareable release or sprint changelog from your merged GitHub pull requests. Moxie Docs creates AI summaries for each merged PR, lets you edit or hide entries, and tag them by audience and category. You can preview the timeline, copy preset sections for reuse, and export when you’re ready to share.
This feature is for maintainers and docs owners who want a clean, readable list of changes without digging through GitHub. Start from the Docs dashboard, review the generated timeline, make your adjustments, and publish your chosen format.
When to use it
- Summarize a sprint or release from merged PRs without manual sorting
- Prepare internal notes for support, sales, or success teams
- Create a public-facing changelog filtered for specific audiences
- Cut noise by hiding minor or irrelevant PRs
How to use it
- Open the Docs dashboard and go to Changelog from PRs for your repository’s timeline.
- Scan the generated entries. Each merged PR appears with an AI summary, date, and linked PR reference.
- Edit any summary to clarify wording. Select the entry, update the text, and save.
- Tag an entry by audience and category to group similar changes. Choose the audience and category that fit how you plan to share updates.
- Hide noise. Mark entries you don’t want to include in this release so they won’t appear in your export.
- Preview your changelog to see how the timeline will read when shared.
- Copy a preset if you want a standard layout or set of sections for your release notes. Apply the preset to organize entries quickly.
- Export the changelog. Choose your preferred export to share with your team or publish externally.
- Repeat as needed. Older items are auto-archived past the retention window, keeping the timeline focused on recent work.
Options and settings
- Changelog timeline: View merged PRs in chronological order for the connected repository.
- Edit summary: Override the AI summary with your own wording.
- Audience: Tag who the change is for (for example, end users, admins, or internal teams).
- Category: Tag what type of change it is (for example, fix, improvement, or doc update).
- Hide entry: Exclude selected items from previews and exports.
- Preview: See the assembled changelog before sharing.
- Copy presets: Reuse a saved structure for consistent release notes.
- Export: Produce a shareable output of the current selection and order.
Tips
- Start by tagging audience and category before editing text. It helps you spot gaps and balance the release narrative.
- Use Hide for dependency bumps or internal refactors that don’t impact readers.
- Keep edits concise—aim for one sentence per entry so the changelog stays scannable.
- If an entry looks off, check the linked PR to confirm scope, then update the summary once for future exports.
Was this page helpful?
Let us know if you found what you were looking for.