Skip to content
myosicam.us

Release Notes Banner

When a new version of MyOsicam is available, the panel shows an Update available banner at the top of every page. If the operator who published the release attached a title and notes, the banner also displays a formatted summary of what changed — so you can read what you are getting before you click Apply update.

What the banner shows

The banner always shows:

  • Update available: followed by the target version number (e.g. 1.7.3).
  • Currently on: your installed version (shown in parentheses).
  • An Apply update button.
  • A × dismiss button.

When release notes are attached to the available release, the banner additionally shows:

  • The release title — a short plain-text headline for the release (e.g. “Bug fixes and SSH stability”).
  • The release notes — a formatted Markdown summary of what changed: headings, bullet lists, inline code, links, and similar standard formatting.

Viewing notes before applying

You do not need to open a separate page to read the release notes. They appear inline in the banner. If the notes are long, the banner section scrolls within itself so the rest of the panel page remains accessible.

When you click Apply update, the confirmation dialog that appears repeats the same title and notes alongside the version string and a reminder that the panel will restart. You have one more chance to read the notes before confirming.

What Markdown constructs are supported

Release notes are written in a limited Markdown subset designed for safe rendering inside the panel. The panel renders the following constructs:

ConstructSyntax
Headings (up to h3)# Heading, ## Sub-heading, ### Sub-sub-heading
Unordered lists- item or * item
Ordered lists1. item
Inline code`code`
Bold**text**
Italic*text* or _text_
Links[text](https://example.com)

Anything outside this set renders as plain escaped text. Raw HTML in the notes source is never passed through — it is always escaped. Links must use http:// or https://; any other scheme (e.g. javascript:) is dropped and the text renders as plain text. Links open in a new tab.

When there are no notes

Older releases published before this feature was introduced have no title and no notes. When a panel detects such a release, the banner shows the version string and Apply update button exactly as it did before the feature was added — no empty section or placeholder label appears.

Notes are captured at detection time

When the panel first detects that an update is available, it stores a snapshot of the title and notes it received at that moment in its update audit log. If the notes are later edited on the admin side, the panel continues to show the version it received at detection time until the next detection cycle. The audit log entry preserves what the operator was shown when they made the decision to apply — this is intentional, for support and audit purposes.