Contributions are always welcome, and if you're unsure about something, please don't hesitate to open an issue.
The rest of this file is dedicated document development and releases for things that I'll otherwise forget.
The package's version lives in cargo.toml
, but is set
in the release workflow based on the release tag. Release tags
should therefore always conform to v{0-9}.{0-9}.{0-9}
Assuming you have a redis server running at :6389
you can debug
a lua script by calling redis-cli -u redis://127.0.0.1:6389 --ldb --eval src/semaphore/rpushnx.lua x 1
.
Just type help
in the debugger for options.
Another option is to run MONITOR
in the redis-cli before running the relevant code,
and checking the output of calls made.
- Create a venv
pip install -r requirements-dev.txt
pre-commit install
And I think that's it!
The tests rely on a Redis instance running on port 6389.
Run docker compose up -d
to start the dc redis.
Rust tests are run with cargo test
, while python tests can be run using pytest .
.
Since some of our tests are written in Rust, and some are written in Python, we've modelled our codecov setup after this project. The process consists of running both test suites with individual coverage tools, then patching the coverage data together via codecov.
To run tests with coverage, you can use the ./coverage-report.sh
script.