Skip to content

docs: sync README and CHANGELOG with outcome, cancel, inspection, pause - #24

Merged
fahimfaisaal merged 2 commits into
mainfrom
docs/sync
Nov 9, 2026
Merged

fahimfaisaal merged 2 commits into
mainfrom
docs/sync

Conversation

@fahimfaisaal

Copy link
Copy Markdown
Member

Docs left stale by #21 (Reject), #22 (job outcome and cancel), #23 (inspection and durable pause). Docs only, no code change.

README

  • House skeleton (as redisq): nav, plain one-sentence intro, no emoji heading or ---, Installation folded into Quick Start, new Trade-offs. Storage and Configuration moved under Usage.
  • worker.WithQueue replaces deprecated WithPersistentQueue.
  • New sections: Job outcome and cancel (WatchOutcome, AcknowledgeResult, CancelJob, OnCancel, AcknowledgeCancelled, 50 ms poll, fixed retention), Job records and inspection, Queue pause.
  • Reject reason: stored as outcome error when job has a job ID (was "not stored").
  • Queue names: __sqliteq_ ban. How It Works: <name>__sqliteq_jobs, <name>__sqliteq_cancelled, __sqliteq_readd trigger, BEGIN IMMEDIATE, poll goroutine, retention trim.
  • With VarMQ: imports VarMQ only in tests (contract module in code), Requires VarMQ ≥ v1.11.0 + link to the VarMQ versions table; no workflow store, one-job read answers 501.
  • New Upgrading from v0.3. Delivery Guarantees: finish row. Casing: VarMQ, ack ID, job ID.

CHANGELOG

Checks

  • go build ./... (examples incl.)
  • grep "WithPersistentQueue\|message queue" README.md empty
  • changed prose sentences <= 25 words
  • facts checked against source (outcome.go, cancel.go, pause.go, inspect.go, registry.go, queue.go)

Note: VarMQ v1.11.0 not tagged yet (go.mod pins a v1.10.1 pseudo-version); line assumes the planned release.

README: house skeleton (nav, intro, Trade-offs, no emoji/rule), WithQueue,
Job outcome and cancel, Job records and inspection, Queue pause, __sqliteq_
name ban, side tables + trigger + BEGIN IMMEDIATE in How It Works,
Requires VarMQ >= v1.11.0, VarMQ casing, ack ID.
CHANGELOG: PR numbers (#21, #22, #23), Breaking Changes heading, one point
per line, sqliteq casing. example/README: sqliteq casing.
Drop cap per transaction, kept cancelled rows, contract import, trusted
producers for the id field, Upgrading from v0.3, split CHANGELOG lines.
@fahimfaisaal
fahimfaisaal merged commit 910c824 into main Nov 9, 2026
@fahimfaisaal
fahimfaisaal deleted the docs/sync branch November 9, 2026 13:33
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