Request a firmware review
Menu
Firmware leads and founders who write the notes for each update

Build firmware release notes people can read

Paste your changes one per line, start each with its type, and the builder sorts them into release notes your support team and customers can read.

Key characteristics

Inputs
Product, versions, date, hardware, changes, known issues, rollout
Output
Plain-text release notes to copy or download
Default example
Fictional LW-1 firmware 1.1.0
Runs
In your browser with nothing sent

Builder: Build firmware release notes people can read

A fictional example is filled in. Change any field; the output updates as you type. Nothing leaves your browser.

Output

Loamwick LW-1 soil probe firmware 1.1.0
Released 2026-11-20, replaces 1.0.2
Hardware: Rev C, Rev D

Security
- The probe now refuses images signed with the retired development key

Added
- Battery voltage in every report

Changed
- Sensor wake-up interval is now set from the gateway

Fixed
- Moisture readings drifted upward after 30 days in wet clay

Known issues
- Probes on Rev C hardware report temperature 0.5 °C high above 40 °C

Installing
- Rollout: Staged in waves
- If the update fails: Device rolls back automatically to the previous version

Release notes are the only part of a firmware release most people will ever read. Support needs them to answer the first call, customers need them to decide whether to care, and your own team needs them six months later when someone asks when a bug was fixed. This builder turns a plain list of changes into notes with a fixed shape: what the release replaces, which hardware it supports, what changed by type, what is still broken, and what happens if the update fails.

How to use it

  1. Fill in the product, the new and previous versions, the release date and the hardware revisions this image supports.
  2. Paste the changes, one per line, each starting with Added, Changed, Fixed, Removed or Security and a colon.
  3. List known issues one per line, then pick the rollout plan and what happens if the update fails.
  4. Copy the output, or download it as a text file.

What each field means

Field What to put in it
Version and previous version Numbers in major.minor.patch form. The builder warns if the version is not in that form or is not higher than the previous one
Hardware revisions Every board revision this image is built and tested for
Changes One change per line that someone outside engineering would notice, written for a reader who has not seen the code
Known issues Problems you know about and are shipping anyway, with the conditions that trigger them
Rollout plan Staged in waves, all devices at once, opt-in only, or manual install by support
If the update fails Automatic rollback, a reinstall by support, or a field service visit

The change types follow the Keep a Changelog convention: Added for new features, Changed for changes to existing behavior, Removed for removed features, Fixed for bug fixes and Security for vulnerabilities. The builder lists Security first, because that is what a security-minded customer looks for. A line that does not start with a type goes under Other, with a warning. Keep a Changelog also has a Deprecated type, which the builder does not sort; use Changed and say what will be removed, and when.

Reading the default example

Example (fictional). Loamwick’s notes for “Loamwick LW-1 soil probe firmware 1.1.0”, released 2026-11-20, replacing 1.0.2, for Rev C and Rev D hardware. Under Security: the probe now refuses images signed with the retired development key. Added: battery voltage in every report. Changed: sensor wake-up interval is now set from the gateway. Fixed: moisture readings drifted upward after 30 days in wet clay. Known issues: probes on Rev C hardware report temperature 0.5 °C high above 40 °C. Installing: rollout staged in waves; if the update fails, the device rolls back automatically to the previous version. The builder shows no warnings.

What makes these notes work: each line says what someone will notice, not what the code does. The known issue names the hardware and the condition, so support can answer a question about a probe that reads warm without asking engineering. And the last two lines answer the first thing a customer with devices in the field will ask: what happens if this goes wrong.

The Security line is invisible to users but closes a real gap. As long as a probe accepts a development key, anyone holding that key can sign firmware the probe will run, and development keys are usually copied far more widely than production keys. MCUboot’s own documentation makes the same point about the sample key it distributes: it is widely shared, so it must never be used in production.

How it builds the notes

The builder reads each change line, matches the word before the colon, capitalizes the first letter of the rest and files it under its type, in the order Security, Added, Changed, Fixed, Removed. Empty types are left out. If the known issues box is empty, the notes say “None known”. It checks that the version is in major.minor.patch form and higher than the previous one, comparing the three numbers in order as Semantic Versioning does. It does not check spelling, tone or whether a change is really visible to anyone.

Limits

  • Plain text only. The output suits email, a support page or a file in the repository. Reformat it for an app’s update screen if you need to.
  • One audience at a time. Customers, support and engineers want different detail. Many teams keep notes like these for customers and support, and a separate engineering changelog with links to commits and tickets.
  • It cannot tell you what to leave out. Say that a vulnerability was fixed, but think about how much detail to publish before most devices have updated.

What to do next

Pair the notes with a version string from the version scheme builder, and run the firmware release checklist before you sign the image. Under our sustaining releases arrangement, every release comes with release notes and a release report written for people who are not engineers; how we work describes the weekly status that goes with them. More on release engineering in the updates and releases section of Field Update.

Send us your board and your plan.

A firmware review reads your schematics, code, flash layout and update plan, and ends with a written plan: what to build first, what could go wrong in the field and how updates will reach your devices.

Request a firmware review

Or email sales@fumbar.com, or call (720) 675-4202.