[fahimfaisaal]

Summary

Docs for #187 (workflow store found by scope) and the adapter stores. Stacked on #186.

- wf := varmq.NewWorkflow(upload.WorkflowStore(), ...)   // store reached through a queue
+ store, err := redisq.NewWorkflowStore(qs)             // or sqliteq.NewWorkflowStore(qs)
+ wf := varmq.NewWorkflow(store, ...)                    // every task-running process creates its store

• guides/workflows.mdx: across-processes rules (store per process, no-store error), Workflows on Redis rewritten, new Workflows on SQLite (file layout, outbox, crash behaviour, close rules, file protection).
• persistence/adapters.mdx: Scoped row replaces WorkflowAcknowledgeable; both adapters have a workflow store; notes for adapter authors.
• persistence/overview.mdx, start/installation.mdx, persistence/sqlite.mdx, persistence/redis.mdx: sqliteq supports workflows.
• operations/rest-api.mdx: /workflows lists registered stores.
• guides/job-ids.mdx: wf: IDs reserved. guides/queues.mdx: removed NumPending line gone.
• docs/examples/go.mod: pins feat!: workflow store found by scope, remove deprecated APIs (contract v0.8.0) #187 (b8a17ac) with a temporary replace for contract v0.8.0.

Evidence

• pnpm test (214), pnpm coverage, pnpm build; docs/examples vet + go test: pass.
• 25-word sentence check: 0. Internal links and anchors: 0 broken.
• Reviews: docs accuracy vs the three source branches, CI/config check, security check; findings fixed in a397a08.

Workflows: across processes

Before

After

Workflows: on Redis

After

Workflows: on SQLite (new)

After

Adapters: optional interfaces

Before

After

Adapters: what redisq and sqliteq implement

Before

After

Redis: pause, outcome, cancel and workflows

Before

After

SQLite: pause, outcome, cancel and workflows

Before

After

Overview: pick an adapter

Before

After

Installation: versions

Before

After

REST: workflows

Before

After

Job IDs: shared storage

Before

After

Queues: Len, Purge and Close

Before

After

Merge Danger

Door: two-way. Docs only.

Blast Radius: docs-site

• Merge last: after docs: sync README, CHANGELOG, spec, examples with main #185, docs(site): sync docs site with main (WithQueue, cancel, pause, workflows, REST) #186 and feat!: workflow store found by scope, remove deprecated APIs (contract v0.8.0) #187, and after contract/v0.8.0 and varmq v1.11.0 are tagged. Then drop the replace and pin the tags.
• Until then, GoPlay "Run" fails on every example: the playground cannot use the replace, and contract v0.8.0 does not exist yet.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

• Source mode: Auto
• Repository: goptics/varmq
• Branch: docs/workflow-store
• File: .coderabbit.yaml
• Commit: a397a08
• Layers: Repository YAML
• Review profile: CHILL
• Plan: Advanced
• Run ID: ba38b758-b1f9-4863-abc4-5fda415b10ad

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• Trigger review

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

• X
• Mastodon
• Reddit
• LinkedIn

[github-actions]

Docs preview: https://varmq-docs-pr-189.fahimfaisaal-dev.workers.dev (built from a397a08). It updates with each push and is deleted when this pull request closes.