Skip to content

docs: update AGENTS local testing workflows#365

Open
shaypal5 wants to merge 1 commit intomasterfrom
codex/update-agents-md-workflows
Open

docs: update AGENTS local testing workflows#365
shaypal5 wants to merge 1 commit intomasterfrom
codex/update-agents-md-workflows

Conversation

@shaypal5
Copy link
Member

Summary

  • document additional local-testing make targets already present in Makefile
  • document parallel test options supported by scripts/test-local.sh
  • add CACHIER_TEST_CORES environment-variable workflow example

Why

Keep AGENTS.md aligned with actual repo workflows/commands so automation and contributors use the same entry points.

Changes

  • add make test-mongo-inmemory
  • add make test-mongo-also-local
  • add make services-logs
  • add -p/--parallel and -w/--workers options
  • add CACHIER_TEST_CORES="mongo redis" ./scripts/test-local.sh example

@shaypal5 shaypal5 added the codex label Mar 13, 2026
@codecov
Copy link

codecov bot commented Mar 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (98f137b) to head (930d569).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #365   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           12        12           
  Lines         1701      1701           
  Branches       213       213           
=========================================
  Hits          1701      1701           
Flag Coverage Δ
local 58.55% <ø> (ø)
mongodb 40.91% <ø> (ø)
postgres 43.85% <ø> (ø)
redis 47.14% <ø> (ø)
s3 42.85% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 98f137b...930d569. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates contributor/agent documentation in AGENTS.md to better reflect existing local-testing workflows (Make targets and scripts/test-local.sh options) used across Cachier’s multi-backend test matrix.

Changes:

  • Document additional make targets (test-mongo-inmemory, test-mongo-also-local, services-logs).
  • Document scripts/test-local.sh parallel options (-p/--parallel, -w/--workers) and CACHIER_TEST_CORES env var usage.

You can also share your feedback on Copilot code review. Take the survey.

Comment on lines 441 to +443
- `make test-mongo-local` - Test MongoDB only
- `make test-mongo-inmemory` - Test MongoDB marker set with local/in-memory setup
- `make test-mongo-also-local` - Test MongoDB together with local core tests
- `-p, --parallel` - Run tests with `pytest-xdist`
- `-w, --workers` - Set number of parallel workers (default: `auto`)

**Note:** External backends (MongoDB, Redis, SQL) require Docker. S3, memory, and pickle backends work without Docker.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants