All notable changes to Squidie will be documented in this file.

The format is based on Keep a Changelog and the project follows Semantic Versioning.

[0.1.2] - 2026-06-03

Changed

  • Rebranded the package, modules, docs, examples, install task, and Hex/GitHub metadata from Squid Mesh to Squidie.
  • Renamed the migration, runtime, workflow, and test module tree to match the new package name.

[0.1.1] - 2026-06-02

Changed

  • Polished README setup and positioning around the embedded runtime, host-owned executor loops, and optional Bedrock-backed delivery.
  • Clarified Bedrock queue, lease, heartbeat, retry, and dead-letter setup with step-by-step examples.
  • Moved Jido primitive boundary guidance into the Jido runtime architecture guide and removed stale roadmap/refactor wording from architecture docs.
  • Expanded production readiness guidance into a feature readiness map focused on adoption planning, operational ownership, and rollout evidence.
  • Linked storage adapter guidance directly to the storage strategy document.
  • Split dense dynamic-work README guidance into visual and tabular reference material.
  • Excluded local Dialyzer PLT artifacts from the Hex package file list.

[0.1.0] - 2026-06-01

Breaking

  • The concise runtime API is now canonical.

Added

  • Runtime command signals, the Jido signal adapter, and signal-interpreter routing for run controls.
  • Durable command receipts and command history in run inspection, including actor, metadata, idempotency, and occurrence details.
  • Numeric transition conditions for workflow routing.
  • Workflow definition version metadata on started runs and inspection surfaces.
  • The safe action registry for executable runtime-authored workflow specs.
  • Runtime-authored workflow start APIs through normalized specs, with safe action registry boundaries and host-app example coverage.
  • Durable child workflow runs and child-run graph links for parent/child inspection.
  • Saga compensation callbacks and compensation recovery metadata for failure recovery inspection.
  • Public dynamic work recording, dynamic work inspection metadata, executable dynamic work scheduling, and validation for dynamic work actions.
  • Dynamic work preview APIs, preview overlays, and graph overlays for visual workflow tooling.
  • Visual editor spec round trips, editor spec action-key validation, and editor draft diffing.
  • Actor-scoped read visibility, node redaction, and comprehensive actor visibility documentation.
  • Deferred continuation runtime semantics and regression coverage for deferred continuation lifecycle behavior.
  • Executor-owned journal heartbeats for long-running claimed attempts.
  • SLA deadline contracts for workflow steps, including persisted deadline metadata, due-soon and escalation timestamps, read-model summaries, graph inspection output, explanations, and host-app example coverage.
  • Bedrock host-app integration coverage for queue delivery, leases, heartbeats, retries, cron delivery, and SLA metadata.

Changed

  • Install snippets now reference 0.1.0.
  • Public status wording now describes the supported 0.1.x journal runtime instead of using the previous evaluation-only warning.
  • README setup guidance now distinguishes the built-in journal runtime from optional external queue/leasing backends such as Bedrock.
  • Host leasing and Bedrock setup docs now describe the executor, queue, lease, heartbeat, retry, and dead-letter boundaries more explicitly.
  • The README, first-run path, workflow examples, and core docs were tightened around current journal runtime usage.
  • Getting Started Livebook dependency setup no longer pins Squidie to a local prerelease dependency.
  • The storage adapter contract and Jido primitive/signal boundaries are now documented explicitly.

Fixed

  • Retry scheduling tolerates invalid deadline metadata by omitting inspection-only retry deadline data instead of crashing the executor failure path.
  • Cron window signal identity and runtime signal validation edges have dedicated regression coverage.

[0.1.0-beta.3] - 2026-05-25

Changed

  • README community links now live in a dedicated Community section instead of the status badge row.
  • Install snippets now reference 0.1.0-beta.3.

[0.1.0-beta.2] - 2026-05-25

Added

  • UI-friendly graph inspection map serialization through Squidie.Runs.GraphInspection.to_map/1, including documented node and edge shapes for dashboards, CLIs, and visual workflow tools.
  • Reference workflow documentation for approval, recovery, dependency, saga, and scheduled workflow examples in the minimal host app.
  • Getting Started and Workflow Authoring Livebooks that execute against the journal runtime and show visible attempts, scheduled wakeups, graph output, manual approval state, normalized specs, dependency joins, and nested input mappings.
  • Discord notification workflow regression coverage for multiline message payloads.

Changed

  • Documentation is reorganized around reader intent, with clearer README entry points, a structured docs home, grouped ExDoc extras, updated observability guidance, and Mermaid architecture diagrams.
  • Getting-started and workflow-authoring examples now keep a consistent fantasy workflow thread while demonstrating the current DSL and runtime inspection APIs.
  • Dependency versions were refreshed for Jido, Req, and ExDoc within the existing supported constraints.

Fixed

  • Discord notification payloads now send real multiline content instead of literal escaped newline sequences.
  • Documentation snippets that inspect, cancel, replay, explain, or graph runs now consistently use the current run_id field.

[0.1.0-beta.1] - 2026-05-24

Added

  • Opt-in journal executor runtime through Squidie.execute_next/1, including durable :run_queued dispatch markers, journal-backed attempt execution, dependency progression, retry scheduling, stale-definition fencing through Squidie.Workflow.Definition.fingerprint/1, and Journal.* runtime modules under Squidie.Runtime.Journal.
  • Durable dispatch-agent claim lifecycle APIs through DispatchAgent.claim_next/4, DispatchAgent.heartbeat/6, DispatchAgent.complete/7, and DispatchAgent.fail/7, including optimistic dispatch-thread fencing, claim-token validation, post-append attempt projection returns, retry scheduling, and expired lease redelivery support for the Jido-native runtime path.
  • Durable workflow-agent result application through WorkflowAgent.apply_result/4, including optimistic run-thread fencing, idempotent duplicate application, and rejection of non-completed, wrong-run, terminal-run, and unplanned dispatch results before writing.
  • Restart recovery for completed dispatch results through WorkflowAgent.apply_pending_results/4, allowing rebuilt workflow and dispatch agents to durably apply results after a lost live wakeup.
  • Restart recovery for planned runnables through WorkflowAgent.schedule_pending_dispatches/4 and DispatchAgent.schedule_attempts/5, allowing rebuilt agents to append missing dispatch intents after a crash between workflow planning and dispatch scheduling.
  • Restart recovery coordination through AgentRecovery.recover/4, which rebuilds workflow and dispatch agents and drains missing dispatch intents before completed dispatch result application.

[0.1.0-alpha.7] - 2026-05-15

Added

  • Pluggable executor boundary for step execution, delayed scheduling, redelivery, and cron activation.
  • Native Squidie.Step modules with raw Jido.Action support retained as an explicit interop path.
  • Durable dispatch protocol documentation and runtime projection invariants for dispatch-oriented state.
  • Runic workflow planner boundary for workflow graph and mapping facts.
  • Jido storage journal boundary, durable rebuild fences, and rebuildable runtime agent checkpoints.
  • Positioning guide and expanded README usage guidance for embedded workflow runtime adoption.

Changed

  • Example workflows now use native Squidie steps instead of raw actions by default.
  • README and host app setup snippets now reference 0.1.0-beta.1.
  • Dependency join explanations and workflow-centric examples were tightened for clearer operator and authoring guidance.

Fixed

  • Planner input/output mappings now align with workflow mappings.
  • Dispatch projection validation now preserves explicit nil fields and hardens projection invariants.
  • Journal replay decoding and agent replay recovery now handle malformed or stale persisted data more defensively.

Notes

  • This is the first beta release. Runtime agents, journal-backed projections, and dispatch protocol boundaries are now the supported contract and should be evaluated with host-app smoke coverage before broader use.

[0.1.0-alpha.6] - 2026-05-13

Added

  • Saga compensation callbacks with compensate: SomeAction, executed in reverse completion order after downstream terminal failure with persisted recovery history.
  • Failure-route recovery markers with recovery: :compensation | :undo on error transitions, plus :compensation_routed and :undo_routed audit events.

  • Local repo transaction groups for custom steps through transaction: :repo, wrapping the step action in the configured repo transaction.
  • Minimal host app examples and smoke coverage for saga checkout, gateway credit compensation routing, and local ledger transaction commit/rollback.

Changed

  • Workflow authoring, operations, README, and host app documentation now distinguish saga rollback, same-step failure routing, undo, and local repo transaction boundaries.
  • Runtime failure and compensation paths now preserve more recovery metadata for inspection and explainability.

Fixed

  • Hardened compensation outcome handling and terminal target serialization for failure recovery routes.
  • Nested exception structs in step error details no longer crash error normalization.

Notes

  • This remains an alpha release. transaction: :repo is a local host repo boundary only; it is not a distributed transaction across durable workflow progress, Oban dispatch, external systems, or compensation callbacks.

[0.1.0-alpha.5] - 2026-05-11

Added

  • Step recovery markers with irreversible: true and compensatable: false for workflows that perform side effects which cannot be safely replayed by default.
  • Persisted recovery policy on step runs, exposed through run inspection, declared step state, and run explanations.
  • Replay safety checks that block Squidie.replay_run/2 after completed irreversible or non-compensatable steps unless the caller passes allow_irreversible: true.
  • Exported formatter rules for Squidie workflow DSL calls, plus host app setup guidance for importing them.

Changed

  • Workflow examples and documentation now use the exported DSL formatter style without unnecessary parentheses.
  • The minimal host app marks its notification step as non-compensatable.

Fixed

  • Recovery marker validation no longer emits a misleading conflict error for non-boolean marker values.
  • Persisted recovery policy normalization now preserves the invariant that irreversible steps are non-compensatable.
  • Replay approval requires allow_irreversible: true exactly; other truthy values no longer bypass the unsafe replay guard.

Notes

  • This remains an alpha release. Existing alpha host apps that already installed earlier Squidie migrations should reinstall from the current schema or apply an equivalent local migration before writing new step runs.

[0.1.0-alpha.4] - 2026-05-10

Added

  • Run explanation diagnostics through Squidie.explain_run/2, including current reason, valid next actions, and supporting evidence for host app dashboards or CLIs.
  • Multiple workflow triggers per workflow, with any mix of manual and cron entrypoints and per-trigger payload validation.
  • Minimal host app documentation and smoke coverage for a workflow that can be started manually or by cron.

Changed

  • mix squidie.install now installs one fresh current-schema Squidie migration instead of copying the historical split migration set.

Fixed

  • Public run APIs now return structured :invalid_run_id errors for malformed run IDs.

Notes

  • This release intentionally does not provide a compatibility path for older split Squidie migrations. Existing evaluation apps should reinstall from the current schema while the project remains in alpha.

[0.1.0-alpha.3] - 2026-05-07

Added

  • Human-in-the-loop workflow support with paused runs and Squidie.unblock_run/2.
  • Approval workflow primitives with approval_step/2, Squidie.approve_run/3, and Squidie.reject_run/3.
  • Manual audit history for pause, resume, approval, and rejection actions when inspecting runs with include_history: true.
  • Operations documentation for idempotent side-effect design and stale running step recovery.

Changed

  • Paused and approval runs now persist their resume targets and output mapping, so existing paused runs keep the same resume behavior across restarts and deploys.
  • Runtime recovery paths now preserve queued step state more carefully during duplicate delivery, cancellation, retry, and dispatch-failure scenarios.
  • Stale running step reclaim is opt-in. By default, a duplicate or redelivered job skips an already running step instead of starting another attempt after a timeout.
  • README and guide language now focuses on setup, runtime behavior, and operational boundaries.

Fixed

  • Invalid execution: configuration now returns structured config errors instead of raising during config load.
  • Runtime telemetry is emitted after the related durable state commits in progression paths that update run or step state.

Notes

  • This remains an alpha release. Steps that call external systems should use application-owned idempotency keys or another duplicate-safety strategy.

[0.1.0-alpha.2] - 2026-05-04

Added

  • Dependency-based workflow steps with after: [...], including durable scheduling of ready steps and dependency-aware host app examples.
  • Explicit error routing for transition workflows with transition(..., on: :error, to: ...) after retries are exhausted.
  • Explicit step input: [...] selection and output: :key namespacing for clearer data flow between workflow steps.
  • Graph-aware inspection with a public steps view alongside chronological step_runs when inspect_run(..., include_history: true) is enabled.

Changed

  • Refactored runtime execution into clearer prepare, execute, and apply phases without changing the public workflow DSL.
  • Hardened dependency-mode concurrency, step claiming, retry progression, and terminal-run dispatch behavior across parallel branch execution.
  • Expanded host app smoke and integration coverage to exercise dependency workflows, mapped step I/O, and nonlinear inspection paths end to end.

Notes

  • This is still an alpha release. The runtime is stronger for evaluation and internal integration work, but the production-readiness bar remains unchanged.

[0.1.0-alpha.1] - 2026-04-28

Added

  • Declarative workflow DSL with manual and cron triggers, payload contracts, built-in steps, transitions, and step-level retry/backoff configuration.
  • Durable runtime built on Postgres and Oban, including replay, cancellation, cron activation, run inspection, and step/attempt history.
  • Tool adapter boundary with an HTTP adapter and runtime observability hooks.
  • Example host app with smoke, resilience, and bounded soak verification paths.
  • Compatibility, operations, and production-readiness documentation.

Changed

  • Clarified the runtime boundary between Squidie, Oban, Jido, and host applications across the README and docs.
  • Disabled Jido's internal action retries at the Squidie boundary so one workflow attempt maps to one persisted step attempt.

Notes

  • This is an alpha release. The runtime is suitable for evaluation, local development, and internal integration work, but it is not yet positioned as production-ready.