Skip to content

docs: fix staleness across agenteval docs#24

Merged
amitpaz1 merged 1 commit into
mainfrom
docs/staleness-audit-fixes
Jul 3, 2026
Merged

docs: fix staleness across agenteval docs#24
amitpaz1 merged 1 commit into
mainfrom
docs/staleness-audit-fixes

Conversation

@amitpaz1

@amitpaz1 amitpaz1 commented Jul 3, 2026

Copy link
Copy Markdown
Member

Fixes verified doc-staleness issues from the audit pass. Docs only — no source logic touched.

  • action.yml — install the correct PyPI package: pip install agentevalkit[==$VERSION] (the package name in pyproject.toml is agentevalkit, not agenteval).
  • examples/docker/docker-compose.yml — worker uses --broker (verified commands/worker.py), not --redis-url. Removed the AGENTEVAL_REDIS_URL env from both services since nothing reads it.
  • examples/github-actions/with-comparison.ymlagenteval run has no --format/-o; JSON output is --report PATH. agenteval compare takes positional run IDs stored in the SQLite DB, not --baseline/--current JSON files. Rewrote accordingly.
  • examples/github-actions/with-gates.yml — same --report fix. compare --gate takes a single gate-policy YAML file (GatePolicy keys: min_pass_rate, score_threshold, max_regressions, max_cost_increase_pct, max_latency_increase_pct) with the current run as the second id (gate applies to the last target). Removed the gate-results.json parsing steps — compare writes no JSON and signals pass/fail via exit code.
  • README.md — the grader registry has 11 (trajectory was added); updated all three "10 graders" counts to 11 and added a table row for the trajectory grader.

🤖 Generated with Claude Code
https://claude.ai/code/session_01CKkfVA3iY5G3Q43Mg4Xsu2

- action.yml: install the correct PyPI package (agentevalkit, not agenteval)
- docker/docker-compose.yml: worker uses --broker (not --redis-url); drop the
  unread AGENTEVAL_REDIS_URL env from both services
- github-actions/with-comparison.yml: run writes JSON via --report (no --format/-o);
  compare takes positional stored run IDs, not --baseline/--current JSON files
- github-actions/with-gates.yml: same run fix; --gate takes a single gate-policy
  YAML file with GatePolicy keys, current run second (gate applies to last target);
  removed gate-results.json parsing (compare signals pass/fail via exit code)
- README.md: 10 -> 11 graders in all three spots; add the trajectory grader row

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CKkfVA3iY5G3Q43Mg4Xsu2
@amitpaz1
amitpaz1 merged commit a4b876e into main Jul 3, 2026
4 checks passed
@amitpaz1
amitpaz1 deleted the docs/staleness-audit-fixes branch July 3, 2026 20:08
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