docs: refresh README and CLAUDE.md after recent worker/store updates - #40
Merged
Conversation
Reflect the changes from PRs #37-#39: richer Claim fields, HandlerContext with the only-Checkpointer-is-fenced caveat, the runquery subpackage, configurable Postgres schema via WithSchema, atomic DeleteRun, the v0.0.3 single-tenant upgrade carry-forward, and the SQLite coexistence note. Lighter tone throughout; replaced the "Going to production" section with a friendlier "Bring your own storage" framing. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughDocumentation updates reframing the library as a pure in-process execution engine, clarifying consumer responsibilities for external storage/infrastructure implementation, and expanding descriptions of experimental submodules including new runquery APIs and storage implementations. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README.mdandCLAUDE.mdto reflect the changes that landed in 002 phase 1.1+1.2: Claim carries WorkerID; fencing calls take *Claim #37, feat: richer NewRun/Claim, HandlerContext, Run API, configurable schema #38, and fix: PR #38 follow-ups — upgrade path, DeleteRun race, runquery lift #39.README.md.What's reflected
Claimnow carriesWorkerID,ProjectID,ParentRunID,InitiatedBy, andMetadata.*HandlerContextwith the only-Checkpointer-is-lease-fenced caveat;SignalStorelives onConfig.experimental/worker/runquery/subpackage as the backend-neutral run query API.WithSchema(...)for configurable schema namespace, withMigrateissuingCREATE SCHEMA IF NOT EXISTS.DeleteRunthat refuses running runs.org_id/initiated_byrewritten toNULL).*sql.DB).GetRun,ListRuns,CountRuns,DeleteRun).Test plan
docs/worker.md,docs/postgres.md,docs/suspension.md,documentation/,examples/signal_wait,examples/durable_sleep,examples/pause_unpause)🤖 Generated with Claude Code
Summary by CodeRabbit