Skip to content

Say what the last change actually did, in the changelog and the docs - #634

Merged
davidmckayv merged 1 commit into
mainfrom
docs/catch-up-with-code
Sep 22, 2026
Merged

davidmckayv merged 1 commit into
mainfrom
docs/catch-up-with-code

Conversation

@davidmckayv

Copy link
Copy Markdown
Contributor

Validated the Unreleased changelog section claim by claim against the tree, then swept the docs for drift. Code was the only source of truth.

Changelog was inaccurate in three places

  • "Unsupported Bun installations are replaced" - the user's binary is explicitly left untouched (install.rs:1002-1018), and the check now gates Start too (preparation.rs:231-232).
  • "repair stays under Installation options" - true on the install screen (App.tsx:762-769), not on the stopped screen where it is still top-level (App.tsx:890-898).
  • "Existing Docker credentials and helper preferences are preserved" - nothing in the tree reads or writes Docker's config.json. The real change is that Address::command() now keeps the inherited PATH instead of replacing it (engine.rs:337-339).

Changelog was incomplete. The entry told a desktop-only story for a commit that also lands on the released server:

  • OPENBOT_MODEL_OAUTH_FILE and the POST /api/model-provider/v1/chat/completions it mounts (provider-oauth.ts:341, index.ts:1313-1315)
  • a 456-line Gemini transport, a new outbound destination for the server (google-oauth-transport.ts)
  • a provider 403 no longer raising "sign in again" (desktop-connection-failure.ts)
  • the leftover-database reset, a destructive action (stack.rs:320-355)
  • the Windows Compose separator fix (stack.rs:508-513)
  • organization sign-in surviving a fragmented callback (organization_auth.rs)

Docs

  • charts/openbot/README.md had zero mentions of podSecurityContext, fsGroup, hostPath or local-path despite 0.0.14 moving computers to uid 1001. An existing k3s install upgrading hits CrashLoopBackOff, because fsGroup is not applied by hostPath-backed provisioners, and the chart docs said nothing. Adds that upgrade note, including the --reuse-values trap.
  • docs/configuration.md: adds SIGNIN_ALLOWED_EMAIL_DOMAINS, OPENBOT_ORGANIZATION_AUTH_URL (with its HTTPS and bare-origin rules) and OPENBOT_ACCESSIBILITY_DISABLED, plus a note that the desktop owns OPENAI_BASE_URL/OPENAI_API_KEY under provider OAuth.
  • docs/architecture.md: the new route beside the other security boundaries.
  • docs/README.md: links PROVIDER_OAUTH.md and TELEMETRY.md, which nothing pointed at.
  • desktop/PROVIDER_OAUTH.md: names VITE_OPENBOT_SUPPORT_URL.

Released changelog sections are byte-identical to main. Docs and changelog only, no code.

The Unreleased entry described a desktop release for a commit that also put a
new route on the server. Rewritten against the code rather than the summary.

What it was getting wrong: Bun is not "replaced", the version already on the
machine is left untouched and simply not used, and the check now gates Start as
well as install. Repair moved under Installation options on the install screen
only; it is still a top-level button on the stopped screen. "Existing Docker
credentials are preserved" described code that is not in the tree, since nothing
reads or writes Docker's config.json; the real change is that the inherited PATH
is now kept and appended to rather than replaced.

What it was missing: OPENBOT_MODEL_OAUTH_FILE and the route it mounts, the
Gemini transport, a provider 403 no longer reading as an expired sign-in, the
leftover-database reset, the Windows Compose separator, and the organization
sign-in fix for a callback that arrives in pieces.

The docs had drifted in the two files that call themselves the full reference.
charts/openbot/README.md never absorbed computers.podSecurityContext, so an
existing k3s install upgrading to 0.0.14 hits CrashLoopBackOff with the
explanation only in the changelog; that upgrade note is the one operators will
actually need. docs/configuration.md was missing SIGNIN_ALLOWED_EMAIL_DOMAINS,
OPENBOT_ORGANIZATION_AUTH_URL and OPENBOT_ACCESSIBILITY_DISABLED, and said
nothing about the desktop owning OPENAI_BASE_URL and OPENAI_API_KEY under
provider OAuth. docs/architecture.md now lists the new route beside the other
boundaries, and the docs index links the two desktop documents nothing pointed at.
@davidmckayv
davidmckayv merged commit 8cabb86 into main Sep 22, 2026
23 checks passed
@davidmckayv
davidmckayv deleted the docs/catch-up-with-code branch September 22, 2026 03:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant