Skip to content

docs(upgrade): no migration notes for 0.1.1, 0.1.2, or 0.1.3 (only the 0.1.0 page exists) #4398

Description

@rhuss

The docs/upgrade/ directory contains only 0-1-0.mdx. Three GA releases have shipped since (0.1.1, 0.1.2, 0.1.3) with no upgrade or migration page for any of them. A reader running 0.1.1 or later has no way to tell whether the 0.1.0 guidance still applies or what changed in their jump.

This matters most for 0.1.3, which is not a pure patch release. From the release notes it includes operator-affecting changes with no migration guidance:

By contrast, 0.1.1 and 0.1.2 look like patch releases (fixes, docs, perf), with only minor behavior changes in 0.1.1 (WebSocket tunnel made opt-in, snap gateway mTLS). If that is correct, even a one-line "no migration steps beyond 0.1.0" note would close the gap for those two.

Request

  1. Add upgrade notes for 0.1.1, 0.1.2, and 0.1.3, even where the entry is simply "no action needed," and state which parts of the 0.1.0 guide still apply.
  2. To prevent recurrence, consider making an "upgrade impact / migration steps" entry a standard part of the release checklist, so each release either links a docs/upgrade/ page or explicitly records that no migration is required. You already publish detailed GitHub release notes (see docs: describe 0.1 series in release callouts #3732); this would add a short upgrade-impact callout rather than a new process.

Found while writing operator upgrade guidance for a downstream consumer (Red Hat Agentic Starter Kits guide) pinned at 0.1.2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    state:triage-neededOpened without agent diagnostics and needs triage

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions