Skip to content

Turn merged GitHub PRs into clean release notes

Convert cryptic commit histories and merged pull request descriptions into grouped customer-facing changelogs via GitHub Actions.

Copy the prompt and paste it into the AI assistant you already use.

Steps to automate clean GitHub changelogs

  1. 01

    Strip pure chore and bot commits

    Exclude dependabot PRs and internal lint commits before summarizing so user notes stay high-signal.

  2. 02

    Separate internal vs public items

    Output two distinct arrays so breaking backend refactors stay in engineering notes only.

  3. 03

    Preserve PR numbers and links

    Pass PR IDs cleanly so generated items retain clickable traceability back to GitHub.

  4. 04

    Review drafts via PR comment

    Post generated release notes into a draft GitHub release for quick two-minute PM signoff.

Common questions

How do I call APIkit automatically whenever we tag a release?

Add a lightweight curl or Fetch step inside your GitHub Actions release workflow passing the merged PR JSON list.

Will internal refactors leak into customer-facing notes?

Classification rules isolate tests, CI scripts, and internal cleanups into an omitted or internal-only bucket.

Does it invent details beyond what's in the PR descriptions?

Strict grounding instructions constrain release bullets strictly to verified PR titles, labels, and summaries passed in the payload.