Set up CodSpeed continuous performance measurement#42
Merged
Conversation
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
Author
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
This PR finalizes the CodSpeed continuous performance testing setup for redis-om-python.
The repository already contained a
pytest-codspeedbenchmark suite (tests/test_performance_benchmark.py, 52 benchmarks covering CRUD, queries, pipelines, JSON/Hash models, embedded models, GEO, and full-text search) and a CodSpeed workflow. This change aligns the workflow with CodSpeed's recommended configuration for Python and makes the results discoverable from the README.Changes
.github/workflows/codspeed.yml: Switched the CodSpeed instrument fromwalltimetosimulation. The CPU simulation instrument is the recommended mode for Python and provides hardware-agnostic, low-variance measurements ideal for catching regressions in the library's client-side overhead (serialization, query building, response parsing).README.md: Added the CodSpeed badge next to the existing status badges.Configuration details
main, on pull requests, and via manual dispatch.id-token: write), so no token secret is required.CodSpeedHQ/action@v4.redis:8-alpineservice (bundles RediSearch and RedisJSON) so the benchmarks have the modules they require.uvand generates the sync module viamake sync, matching the existing CI.Validation
The benchmark suite was executed locally with the CodSpeed CLI in simulation mode against a real Redis 8 instance with RediSearch and RedisJSON loaded. Benchmarks ran and uploaded results successfully, confirming the harness and instrumentation work end to end.
Next steps
main.