Release notes
Release notes travel with the release.
The notes ship inside the release bundle: what’s new, what changed, what was fixed, and what you may notice after you update.
Where to find them
Inside the bundle you install.
The notes in a bundle are the notes for the version in that bundle. The release build refuses to run without a notes file for that exact version.
The notes file
The bundle carries its notes as docs/RELEASE_NOTES.md. The file is listed in the bundle’s checksums, so the checksum check covers the notes too.
The version you run
Admin → Diagnostics shows it under Current version, and the host keeps it in /opt/netends/VERSION. Compare it with the upgrade line near the top of the notes before you update.
What’s inside
What the notes tell you.
- Version and date
- The version string your install reports, and the release date.
- Upgrade path
- The oldest version the release installs over, or a line saying it installs over any earlier version.
- Summary
- A few sentences on the release as a whole.
- Named changes
- New, Removed, Changed, Fixed and Performance, in that order, with only the sections the release needs. Removed comes right after New, so a withdrawn capability is never buried.
- What you may notice
- Every Changed and Removed entry carries this paragraph: what will look or behave differently, and what to do about it.
- Also in this release
- One counted line each for security hardening and behind-the-scenes fixes that need nothing from you.
# NetEnds <version> Released <date>. Install this over <version> or newer. If your install is further behind, apply the releases in between first. <A short summary of the release> ## New ## Removed ## Changed ## Fixed ## Performance ## Also in this release
Updating
Read the notes, then update.
If your install is older than the version the upgrade line names, apply the releases in between first. An update applied with the updater has to pass a health check before it counts as installed, and one that fails the check rolls back to the release you were on.
The full procedure is in the documentation.
Start on the current release.
Fourteen days, every tier on, on a host you own. Its notes come in the bundle.