fix(actor): add v3 YAML text generation for built-in actors #10894
Merged
hurui200320
merged 1 commits from 2026-04-28 16:35:35 +00:00
bugfix/m3-built-in-actor-v3-yaml into master
Labels
Clear labels
auto/needs-reevaluation
controller-managed
overdue
auto/blocked-by-deps
auto/ci-timeout
auto/claimed-implementer
auto/claimed-merge
auto/claimed-reviewer
auto/driver-down
auto/invariant-violation
auto/last-attempt-tier-0
auto/last-attempt-tier-1
auto/last-attempt-tier-2
auto/last-attempt-tier-min
Automation Tracking
auto/needs-conflict-resolution
auto/needs-implementer
auto/postmortem
auto/ready-to-merge
auto/restart-throttled
auto/revert
auto/sentinel
auto/stale-inactivity
auto/unstable
Blocked
Needs Feedback
Signed-off: Owner
Signed-off: Scrum Master
Signed-off: Tech Lead
Spike
Controller deferred this PR; awaiting Phase 6+ scope-evaluator or operator re-enablement.
Auto-agents controller manages this PR/issue (see tools/controller/deploy/RUNBOOK.md). Remove this label to abandon controller management.
PR blocked by an open issue dependency. Operator must close the dep (or remove the dependency link) before the merge driver can act. Auto-cleared by merge_drive when no open deps remain.
Most recent merge cycle hit CI timeout. Driver excludes this PR while last merge_cycle row is < 30 min old; label persists thereafter as visible history.
Currently being processed by an implementer worker.
Currently being processed by the merge driver.
Currently being processed by a reviewer worker.
Merge driver heartbeat stale; pipeline halted. Closed automatically on next clean tick.
Detected master commit violating the strict merge invariant. Tracked as an issue (not a PR label); kept here for label completeness.
In-cycle escalation: most recent attempt ran at the Tier 0 slot (`tier-0`). Slot's model defined in .opencode/models/tiers.yaml.
In-cycle escalation: most recent attempt ran at the Tier 1 slot (`tier-1`). Slot's model defined in .opencode/models/tiers.yaml.
In-cycle escalation: most recent attempt ran at the Tier 2 slot (`tier-2`). Slot's model defined in .opencode/models/tiers.yaml. Gated behind IMPLEMENTER_ESCALATION_TIER2_ENABLED.
In-cycle escalation: most recent attempt ran at the Tier -1 slot (`tier-min`). Slot's model defined in .opencode/models/tiers.yaml. Suffix is ``-min`` (not ``--1``) so the Forgejo UI reads naturally.
Tracking issues used by the AI Automation system for agents to communicate and report.
Rebase conflict needs LLM conflict-resolver.
Failing CI needs implementer attention.
Documenting a driver incident or rollback.
Reviewer has APPROVED this PR and no later REQUEST_CHANGES is outstanding. The merge driver requires this label to even consider a PR for merging. Set by the reviewer worker on APPROVE; cleared on REQUEST_CHANGES.
Train repeatedly lost master-tempo races. Driver excludes via merge_cycle until cooldown elapses; label persists as visible history.
Revert PR backing out an invariant violation. Fast-tracked through the merge driver.
Sentinel PR duplicated from upstream into a personal fork by tools/duplicate_prs_to_fork.py for pipeline testing. Lives only in the fork; the canonical pipeline never sees it.
No implementer activity for N days. Flagged for human review. Auto-cleared on next push to head branch.
Repeatedly fails on current master (>= 3 ci-fail-on-rebased-sha releases in 12 h). Excluded from driver until human triage.
A ticket in a blocked state and unable to complete until some other task is completed first.
Bounty
$100
A bounty of $100 for any open-source contributor who provides a MR that solves this issue
Bounty
$1000
A bounty of $1000 for any open-source contributor who provides a MR that solves this issue
Bounty
$10000
A bounty of $10000 for any open-source contributor who provides a MR that solves this issue
Bounty
$20
A bounty of $20 for any open-source contributor who provides a MR that solves this issue
Bounty
$2000
A bounty of $2000 for any open-source contributor who provides a MR that solves this issue
Bounty
$250
A bounty of $250 for any open-source contributor who provides a MR that solves this issue
Bounty
$50
A bounty of $50 for any open-source contributor who provides a MR that solves this issue
Bounty
$500
A bounty of $500 for any open-source contributor who provides a MR that solves this issue
Bounty
$5000
A bounty of $5000 for any open-source contributor who provides a MR that solves this issue
Bounty
$750
A bounty of $750 for any open-source contributor who provides a MR that solves this issue
MoSCoW
Could have
Could have feature in order to satisfy the epic/legendary.
MoSCoW
Must have
Must have feature in order to satisfy the epic/legendary.
MoSCoW
Should have
Should have feature in order to satisfy the epic/legendary.
There are questions in the ticket that can not be completed until the project owner provides clarity.
Points
1
1 man-hours worth of work for an expert with no learning curve.
Points
13
13 man-hours worth of work for an expert with no learning curve.
Points
2
2 man-hours worth of work for an expert with no learning curve.
Points
21
21 man-hours worth of work for an expert with no learning curve.
Points
3
3 man-hours worth of work for an expert with no learning curve.
Points
34
34 man-hours worth of work for an expert with no learning curve.
Points
5
5 man-hours worth of work for an expert with no learning curve.
Points
55
55 man-hours worth of work for an expert with no learning curve.
Points
8
8 man-hours worth of work for an expert with no learning curve.
Points
88
88 man-hours worth of work for an expert with no learning curve.
Priority
Backlog
This ticket has backlogged priority and is not to be worked on yet
Priority
CI Blocker
Critical priority issue that blocks CI/CD pipeline and prevents PR merges
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
A ticket for learning a tool or technology that is needed to be able to do future planning and design.
State
Completed
The ticket has been fully implemented, completed, and merged with the source code. This label should only be applied once a ticket is closed.
State
Duplicate
A ticket that represents the same content as an existing ticket.
State
In Progress
A ticket that is actively being developed.
State
In Review
A ticket that has had some code completed to implement but is waiting to pass peer review and is not yet merged in.
State
Paused
This ticket's work started but wasn't finished. It's on hold (likely in a feature branch) and will be resumed later, either due to a blocker or a delay.
State
Unverified
All new tickets start in this state. A developer may set it to show the ticket is unverified. This means we haven't agreed to work on it. It will either move to a verified state or be closed as wontdo.
State
Verified
The issue has been verified by a developer as legitimate. It will be worked on and verified tickets are now considered part of the backlog.
State
Wont Do
This ticket has been decided it wont be done. This may mean the bug has been determined to not be real (cant verify) or the feature is one we have decided we dont want to adopt.
Type
Automation
Any edits or discussion about the AI automated coding system.
Type
Bug
Something that doesnt work as intended.
Type
Discussion
Anytime a ticket represents a discussion about a subject and doesnt fall into one of the other categories.
Type
Documentation
An error or improvement needed in the documentation.
Type
Epic
Any first tier epic. That is, an epic which contains only issues as children and will not have sub-epics.
Type
Feature
Some new functionality not present.
Type
Legendary
A type of Epic which will contain other Epics.
Type
Refactor
A code change that restructures existing code without changing its external behavior.
Type
Support
Someone needs help using the project.
Type
Task
A generic task that doesnt fit into the other type categories.
Type
Testing
Work exclusively focusing on fixing or expanding testing.
Projects
Clear projects
No project
Assignees
aditya (Aditya Chhabra)
aleenaumair (Aleena Umair)
brent.edwards (Brent Edwards)
CoreRasurae (Luis Mendes)
drew (Drew Morris)
eugen.thaci (Eugen Thaci)
freemo (Jeffrey Phillips Freeman)
HAL9000 (HAL 9000)
HAL9001 (HAL9001)
hamza.khyari (Hamza Khyari)
hurui200320 (Rui Hu)
justin.morris
khird (Kyle Hird)
org.cleveragents
Clear assignees
Notifications
Due Date
No due date set.
Blocks
#10883 Update built-in actors to use v3 YAML format with `type` field
cleveragents/cleveragents-core
Reference: cleveragents/cleveragents-core#10894
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Delete Branch "bugfix/m3-built-in-actor-v3-yaml"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
Fixes built-in actors (e.g.,
openai/gpt-4,anthropic/claude-3-opus) to work withagents actor runcommand by generating and persisting v3 YAML text with requiredtypeanddescriptionfields.Changes
Core Implementation
src/cleveragents/actor/registry.py: Added_generate_builtin_actor_yaml()helper method that generates spec-compliant v3 YAML text for built-in actorssrc/cleveragents/actor/registry.py: Modifiedensure_built_in_actors()to generate and persistyaml_textviaupsert_actor()Testing
features/builtin_actor_v3_yaml.feature: BDD scenarios covering v3 YAML format validationfeatures/steps/builtin_actor_v3_yaml_steps.py: Step definitions for new scenariostests/actor/test_registry_builtin_yaml.py: Unit tests for YAML generation and schema validationDocumentation
CHANGELOG.md: Added entry under Fixed sectionTechnical Details
Root Cause
Built-in actors were created without
yaml_text, causingReactiveConfigParser._is_v3_format()to fail (notypekey), resulting in:agentsandroutesdictionariesrun_single_shot()returning empty output silentlySolution
Generated v3 YAML includes:
Backward Compatibility
ensure_built_in_actors()callTest Step Design Notes
The
agents actor runscenario uses a dedicated mock stepI call agents actor run with mock "{actor_name}"rather than the genericI run "{command}"step (which invokes the real CLI with no LLM mocking).This keeps the scenario firmly in unit-test territory — it exercises only the
actor-lookup and v3-format-check logic, not the LLM invocation path.
Quality Gates
nox -s lint✓nox -s typecheck✓nox -s unit_tests✓ (668 features, 15 664 scenarios passed)Related Issues
Closes #10883
db6ff7ba58to0ca74437f10ca74437f1toba8fadde27ba8fadde27todfb6c932c2@HAL9000 Please review this PR
dfb6c932c2to3f710605603f71060560tod9cdcdd230Reviewed ✅
All 10 checklist categories pass. CI is green. No blocking issues found.
Non-blocking: Pre-existing duplicate comment block in registry.py lines 283-286 (not PR-introduced, but worth a follow-up cleanup).
Ready for merge.
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker
d9cdcdd230tobb6765d85eReview Summary — PR #10894: fix(actor): add v3 YAML text generation for built-in actors
CI Status
All 14 CI checks passing (lint, typecheck, security, unit_tests, integration_tests, e2e_tests, coverage, build, docker, helm, push-validation, status-check). CI is green. ✅
Checklist Results
CORRECTNESS ✅ — The code correctly addresses the root cause: built-in actors were persisted without
yaml_text, causingReactiveConfigParser._is_v3_format()to fail. The fix generates spec-compliant v3 YAML with the requiredtype: llmanddescriptionfields, which is then passed toupsert_actor(). TheActordomain model has ayaml_textfield, so persistence is correct. All acceptance criteria from the PR body are met.SPECIFICATION ALIGNMENT ✅ — The generated YAML follows the
ActorConfigSchemaformat (withtypekey set tollm), whichis_v3_yaml()detects correctly. All required top-level fields (name,type,description) are present. Themodelfield includes the full provider/model path (provider/model), consistent with how the spec expects model references.source: provider-registrycorrectly identifies this as auto-generated rather than user-authored.TEST QUALITY ✅ — Comprehensive test coverage:
builtin_actor_v3_yaml.featurecovering type field presence, required v3 fields, CLI command execution, and schema validation. Well-named scenarios that read as living documentation.TestGenerateBuiltinActorYamlandTestEnsureBuiltInActorYaml). Covers individual YAML fields, v3 detection, schema validation, capabilities inclusion, slash sanitization (OpenRouter edge case), multi-provider scenarios, and empty-provider edge case.actor_registry_steps.pystubs, maintaining consistency with the existing test architecture.TYPE SAFETY ✅ — All function signatures and return types are annotated.
_generate_builtin_actor_yamlusesdict[str, Any]andProviderCapabilities | Noneproperly. TheAnyimport fromtypingis used correctly. No# type: ignorecomments anywhere.READABILITY ✅ — Clean, descriptive names. The
_generate_builtin_actor_yamlmethod clearly separates concern fromensure_built_in_actors. The YAML dict construction with None-value filtering (yaml_dict = {k: v for k, v in ...}) is concise and readable. Comments inensure_built_in_actorsexplaining the name sanitization vs. raw provider/model intent are helpful.PERFORMANCE ✅ — Lightweight change. YAML generation runs once per configured provider during
ensure_built_in_actors(). No loops or N+1 patterns. Thesort_keys=Falseparameter inyaml.safe_dump()avoids unnecessary sorting overhead.SECURITY ✅ — No hardcoded secrets, tokens, or credentials. Uses
yaml.safe_dump()(notyaml.dump()), which prevents arbitrary Python object instantiation. No external inputs involved. The description string is constructed from provider/model names which are already validated by the provider registry.CODE STYLE ✅ — SOLID principles followed: single responsibility (YAML generation is isolated in
_generate_builtin_actor_yaml). Files are under 500 lines (registry.py ~470 lines). Follows ruff conventions. Consistent with the existing codebase patterns. Note: pre-existing issues (duplicate comment block on lines 334-335, duplicate@staticmethoddecorator in config.py line 43) are NOT introduced by this PR and are noted as non-blocking for follow-up.DOCUMENTATION ✅ —
_generate_builtin_actor_yamlhas a thorough docstring covering purpose, args, and return type. Theensure_built_in_actorsdocstring was updated to document the new v3 YAML behavior. Changelog entry is clear and user-facing. The BDD scenarios serve as living documentation for the feature.COMMIT AND PR QUALITY ✅ — Single atomic commit with correct conventional changelog format (
fix(actor): add v3 YAML text generation for built-in actors). Changes are tightly scoped: only YAML text generation for built-in actors. 5 changed files, 688 additions, 1 deletion. Clean diff with no unrelated changes.Non-blocking observations (not preventing approval):
Comment 1, line 334:
# Legacy upsert (preserved for backward compatibility)appears twice (lines 334-336). This is an existing artifact, not PR-introduced. Worth cleaning up in a follow-up.Test stub duplication: The step file
builtin_actor_v3_yaml_steps.pydefines_StubActorServiceand_StubProviderRegistryclasses, then also imports them fromfeatures.steps.actor_registry_steps. Consider deduplicating — either the steps file should only use the existing stubs, or the stubs should be moved to a shared test utilities module. This is a pre-existing pattern in the codebase though.Changelog entry: Could be slightly more concise and could include the PR number (#10894) in addition to the issue number for traceability. Minor suggestion.
Conclusion
All 10 checklist categories pass. The PR correctly and comprehensively addresses the bug described in #10861/#10883. The fix is minimal, well-tested, and follows project conventions. CI is fully green. No blocking issues found. Ready for merge.
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker