docs(spec): align checkpoint trigger names and config key path with implementation
CI / push-validation (push) Successful in 37s
CI / helm (push) Successful in 37s
CI / benchmark-publish (push) Failing after 44s
CI / build (push) Successful in 1m6s
CI / lint (push) Successful in 1m33s
CI / security (push) Successful in 1m53s
CI / quality (push) Successful in 1m59s
CI / typecheck (push) Successful in 2m0s
CI / integration_tests (push) Successful in 3m58s
CI / e2e_tests (push) Successful in 5m9s
CI / unit_tests (push) Successful in 6m30s
CI / docker (push) Successful in 1m29s
CI / coverage (push) Successful in 11m12s
CI / status-check (push) Successful in 3s
CI / benchmark-publish (pull_request) Has been skipped
CI / build (pull_request) Successful in 37s
CI / coverage (pull_request) Successful in 12m19s
CI / push-validation (pull_request) Successful in 22s
CI / lint (pull_request) Successful in 1m0s
CI / typecheck (pull_request) Successful in 1m19s
CI / quality (pull_request) Successful in 1m16s
CI / security (pull_request) Successful in 1m33s
CI / helm (pull_request) Successful in 27s
CI / e2e_tests (pull_request) Successful in 3m22s
CI / integration_tests (pull_request) Successful in 3m54s
CI / unit_tests (pull_request) Successful in 5m24s
CI / docker (pull_request) Successful in 1m56s
CI / status-check (pull_request) Successful in 3s

- Update trigger names from 'on_tool_write' and 'on_tool_write_complete' to 'before_tool_execute' and 'after_tool_execute' to match the actual implementation in config_service.py
- Correct config key path from 'core.checkpoints.auto_create_on' to 'checkpoints.auto_create_on' to match the actual configuration structure
- Update TOML configuration examples to use comma-separated string format instead of array format, matching the actual ConfigService implementation
- Update references to trigger names in the CLI Usage section to use the correct names
This commit was merged in pull request #10865.
This commit is contained in:
2026-04-26 21:45:53 +00:00
committed by Forgejo
parent f5ef9df1f0
commit 98bc7c6b5d
+8 -8
View File
@@ -61,28 +61,28 @@ The rollback operation enforces two guards:
## Automatic Checkpoint Triggers (v3.8.0+)
The execution engine now supports four automatic checkpoint triggers, all
configurable via `core.checkpoints.auto_create_on` (default: all enabled):
configurable via `checkpoints.auto_create_on` (default: all enabled):
| Trigger | When | Component |
|---------|------|-----------|
| `on_tool_write` | Before each write-tool execution | `ToolRunner` |
| `on_tool_write_complete` | After each write-tool execution | `ToolRunner` |
| `before_tool_execute` | Before each write-tool execution | `ToolRunner` |
| `after_tool_execute` | After each write-tool execution | `ToolRunner` |
| `on_subplan_spawn` | Before first subplan execution attempt | `SubplanExecutionService` |
| `on_error` | When the Execute phase fails | `PlanExecutor` |
### Configuration
```toml
[core.checkpoints]
auto_create_on = ["on_tool_write", "on_tool_write_complete", "on_subplan_spawn", "on_error"]
[checkpoints]
auto_create_on = "before_tool_execute,after_tool_execute,on_subplan_spawn,on_error"
```
To disable a specific trigger, remove it from the list. To disable all
automatic checkpoints:
```toml
[core.checkpoints]
auto_create_on = []
[checkpoints]
auto_create_on = ""
```
### Wiring
@@ -103,7 +103,7 @@ When `checkpoint_service` is `None`, all automatic checkpointing is skipped
Checkpoints are created automatically by the execution engine via the four
triggers above, or manually via `CheckpointService.create_checkpoint()`.
The `CheckpointScope` on each tool's capability declaration controls which
tools trigger `on_tool_write` / `on_tool_write_complete` checkpoints.
tools trigger `before_tool_execute` / `after_tool_execute` checkpoints.
### Rollback to a checkpoint