[DOC] Update documentation for running tests with local Docker services#1717
Open
MOHITKOURAV01 wants to merge 1 commit intoopenml:mainfrom
Open
[DOC] Update documentation for running tests with local Docker services#1717MOHITKOURAV01 wants to merge 1 commit intoopenml:mainfrom
MOHITKOURAV01 wants to merge 1 commit intoopenml:mainfrom
Conversation
- Add 'Running Tests Against Local Services' section to docs/developer_setup.md - Add local services testing instructions to CONTRIBUTING.md - Document the Docker-based local test server setup (clone services repo, set permissions, start docker compose, set OPENML_USE_LOCAL_SERVICES env var) - Include cleanup instructions Fixes openml#1708
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
1 participant
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.
Metadata
Details
What does this PR implement/fix?
Updates the documentation to explain how contributors can run the test suite using local Docker services, as introduced in [MNT] Dockerized tests for CI runs using localhost #1629 and [MNT] Update CI/CD with local test server and dependency matrix #1697.
Changes made:
The documentation covers:
openml/servicesrepositorychmod -R a+rw ./data ./logs)rest-api,minio,evaluation-engine)OPENML_USE_LOCAL_SERVICESenvironment variableWhy is this change necessary?
The CI was recently switched to run tests against local Docker services instead of the remote test server ([MNT] Dockerized tests for CI runs using localhost #1629, [MNT] Update CI/CD with local test server and dependency matrix #1697), but the documentation was not updated to reflect this change. Contributors need clear instructions on how to replicate the CI setup locally.
How can I reproduce the issue this PR is solving and its solution?
Follow the steps described in the updated docs/developer_setup.md to start the local services and run the tests with
OPENML_USE_LOCAL_SERVICES=true.