Development¶
Running the servers locally¶
The easiest way to run the API server(s) is with Docker Compose:
Running Tests¶
Contributing¶
- Fork the repository
- Create a feature branch
- Commit your changes
- Push to the branch
- Create a Pull Request
Releasing Agent Memory Server¶
Merging a PR to the main branch will trigger building and pushing a new image to Docker Hub based on the commits in main (including the version number). Currently, that image pushes to a test project:
https://hub.docker.com/r/redislabs/agent-memory-server
Releasing Agent Memory Client¶
For the client, the workflow is different. First, merge your PR to main. Then tag a commit (from main) and push to a tag based on the format client/vx.y.z-test
or client/vx.y.z
:
-
Test PyPI: Use
-test
in the version tag. For example: -
Production PyPI: Do not include
-test
in the version tag: ``` $ git tag client/v0.9.0b2 $ git push client/v0.9.0b2