Skip to main content

Installation

Install the package via Composer:

composer require discovery-ukraine/saga-lara-flow

Run the migrations:

php artisan migrate

The engine's migration ships with the package and is loaded into the migrator directly, so migrate picks it up with no publish step. Future versions add their migrations the same way — composer update then php artisan migrate is all a host app needs.

Optionally publish the config file:

php artisan vendor:publish --tag="saga-lara-flow-config"

Customize the schema through config — database.table_prefix, database.connection, and the swappable models.* — rather than by editing the migration.

Don't publish the migration

The migration runs automatically from the package. If you also vendor:publish it, migrate will try to run both the published copy and the package's own and fail with a duplicate-table error. Publishing the migration is not part of the install flow.

Requirements​

  • PHP ^8.5
  • Laravel 13 (illuminate/*: ^13)
  • A queue connection you can run workers against (database, Redis, SQS, …). The sync driver works for runSync() but not for the queued, suspend-and-replay paths.

The package auto-registers its service provider and the SagaFlow facade through Laravel's package discovery — no manual wiring required.

What gets installed​

  • A single migration, create_saga_lara_flow_initial_tables, creating the engine's tables (flow runs, action runs, events, signals, tags, children, compensations, side effects), all prefixed with saga_ by default.
  • The config/saga-lara-flow.php config file (see Configuration).
  • The SagaFlow facade and a set of saga-flow:* Artisan commands.