What is Release Planner?
Release Planner makes it easy to publish release notes people actually want to read. Release Planner plus your coding agent do the tedious work of reviewing what changed and drafting the notes. You stay in charge of what ships: nothing is published until you approve it.
Release Planner works with GitHub only for now. It publishes GitHub releases, and it runs on GitHub Actions.
What making a release looks like
Section titled “What making a release looks like”With Release Planner set up, here’s how a new release happens:
-
You ask for a release. Tell your agent “let’s release.”
-
Your agent drafts it. Release Planner lists every change since your last release. Your agent reads them, writes the notes, picks the version, and opens a pull request titled something like Release v1.1.0.
-
You review it. Change anything you like; nothing is published yet. Meanwhile, Release Planner’s GitHub Actions workflow checks the release, builds any files it ships, and shows its progress in the pull request.
-
You merge it. Merging approves the release.
-
It’s published. The workflow tags the release commit and publishes your new version on the Releases page, with exactly the notes you approved and the files the pull request built.
You do three things: ask, review, and merge. There’s no changelog to maintain, no commit message conventions to follow, and no release checklist to remember.
What the release notes look like
Section titled “What the release notes look like”Here’s an example of what your readers see on GitHub:
This release adds rules for Svelte and fixes a misleading Zustand example. No existing rules changed, so upgrading requires no changes to your configuration.
✨ New Features
Section titled “✨ New Features”Svelte rules
A new techs/svelte group with six rules for writing Svelte 5 components with runes, including when to use $derived instead of $effect. (#7, #9)
🐛 Squashed Bugs
Section titled “🐛 Squashed Bugs”techs/zustand/rehydrate-persisted-stores-after-hydrationno longer shows reading storage during server rendering. (#8)
Pull Requests
Section titled “Pull Requests”✨ Features
- feat: add a Svelte group by @ada in #7
- feat(svelte): add examples for stores and snippets by @grace in #9
🐛 Bug Fixes
- fix(zustand): correct the hydration example by @ada in #8
Full Changelog: v1.0.0…v1.1.0
Release Planner comes with an opinionated release notes style, shown above.
The style is fully customizable. You can add your own rules on top of it, such as always naming affected API endpoints, or replace it entirely with your own headings and format. See Release notes style.