reph

Templates · Engineering

Release notes template

What shipped, what changed, and how to upgrade

Start with this template →Sign in

Opens on reph with the template ready to start. No account needed; sign in to keep your document.

Use it when

A version is going out and users, customers or downstream teams need to know what changed, what broke and how to upgrade

Who it's for

EngineerTech leadProduct manager

Part of a kit

Product launch, step 5 of 6. From brief and PRD through experiment, launch checklist, release notes and the customer newsletter.

Filled example

The template filled in for a made-up company, so you can see what good looks like.

Halcyon Sync v3.4.0

Date: 2026-09-30

Highlights

  • Selective sync lets you choose which folders sync to each device, so laptops with small disks stop filling up.
  • Conflict copies are gone for text files: edits from two devices now merge line by line.
  • Uploads of large files are up to 2.3x faster on connections over 100 Mbps.

New

  • Selective sync per device, under Settings, Folders. Unchecked folders stay in the cloud and remain shareable.
  • halcyon status --json prints sync state in a machine-readable form for scripts and monitoring.
  • Admins can set a workspace-wide bandwidth cap from the admin console.

Improved

  • Large uploads now use parallel chunks (4 by default, configurable with upload.parallelism).
  • The tray icon shows the number of files still syncing, not just a spinner.
  • Startup on folders with over 200,000 files is about 40% faster thanks to a cached index.

Fixed

  • Files renamed only by letter case (Report.pdf to report.pdf) on macOS now sync correctly (#2214).
  • Sync no longer stalls after the laptop wakes from sleep on a different Wi-Fi network (#2190).
  • Shared links created from the mobile app now respect the workspace's link expiry policy (#2231).

Breaking changes

  • What changed: The sync.ignore file now uses gitignore syntax instead of plain glob lines. Patterns like *.tmp still work, but a leading / now anchors to the sync root. Migration: Run halcyon ignore --check to list any pattern whose meaning changed, then edit those lines. Most users need no changes.
  • What changed: The minimum supported version of Windows is now Windows 10 21H2. Migration: Upgrade the OS, or stay on v3.3.x, which receives security fixes until 2027-03-31.

Deprecations

  • The --legacy-auth CLI flag is deprecated. Use halcyon login --device instead. The flag will be removed in v4.0, planned for Q2 2027.

Known issues

  • Selective sync settings do not yet transfer when you replace a device; set them again after signing in. A fix is planned for v3.4.1.
  • On Linux with Btrfs, the first scan after upgrade can take several minutes.

Contributors

Thanks to Ana Lima, Dmitri Sokolov, Hana Ito and Tomas Berg, and to first-time contributors @kwame-codes (the case-rename fix) and @lucia-r (the JSON status output).

The template

Show the blank template

Release notes v0.0.0

Date: [date]

Highlights

The two or three things a busy user actually needs to know about.

New

Net-new capability that didn't exist in the previous release.

Improved

Existing behavior that got faster, clearer or more capable.

Fixed

Bugs closed, specific enough that an affected user recognizes their issue.

Breaking changes

Anything that requires the consumer to change code or config.

  • What changed: Migration: step-by-step, or a link to a migration guide

Deprecations

  • What's deprecated, what to use instead, and the removal timeline

Known issues

Problems you know ship in this release, each with its workaround and when a fix is expected.

Contributors

Thanks whoever shipped this, including first-time contributors by name.

Questions

Who are release notes for?
The people upgrading, so lead with what they will notice and what they must do
What counts as a breaking change?
Anything that makes a consumer change code, config or workflow to keep working
Should every PR be listed?
No. Group small fixes, and link the full changelog for completeness

Fill it with your agent

Connect Claude to reph over MCP, then paste this. The draft arrives as suggestions you accept or reject section by section. How to connect Claude.

Find my reph doc "Release notes" with search_docs, then read it with read_doc. Draft from the merged pull request titles and descriptions, closed issues and changelog fragments for this release I paste. Write for users, and put anything needing a config or code change under Breaking changes with migration steps. File it with suggest_edit, one replace_section op per section (heading line kept) so each can be accepted alone. Ask each open question (unclassified changes, unnamed contributors) with add_comment quoting that section's heading line, then call request_review with a one-line summary.

Related templates

Start with this template →Sign in