Upgrading

Move an OpenUI Rails application between documented gem releases with the required code and configuration changes.

After reading this guide, you will know:

  • How to install the first gem release.
  • Which changes affect applications built from an earlier Git checkout.

Install version 0.1.0

Replace a Git dependency with the published gem in your application’s Gemfile:

gem "openui-rails", "~> 0.1.0"

Run bundle update openui-rails. New applications can follow Getting Started. This is the first gem release, so there is no upgrade from an earlier published version.

Move from a development checkout

If your application used an earlier Git revision, review these changes:

  • Custom idempotency stores distinguish pending claims from completed replays, return a claim token, and accept record(..., claim_token:). See Configuration.
  • The engine inherits your host’s ApplicationController and retains its authentication filters. This release requires full-stack controllers. API-only authentication and CSRF integration need separate qualification.
  • Surface helpers and the browser verify the configured library identity. A custom prompt and spec need a matching custom browser runtime. See Library Contract.
  • Add <%= openui_stylesheet_tag %> once in your layout. Fetch the pinned JavaScript, CSS, and upstream license with bin/rails openui:runtime:fetch. See Runtime Assets.
  • Terminal stream frames use the same sequence checks as deltas. After a gap, your host must deliver an authoritative snapshot before streaming resumes. See Streaming.

Keep database constraints and transactions around irreversible host actions. Idempotency TTL expiry and process restarts do not provide an exactly-once guarantee.

Next Steps