Skip to content

[DOC] Update documentation for running tests with local services #1708

Description

@geetu040

We recently switched the CI to run tests against local services using Docker instead of the remote test server. This change was introduced in:

The documentation should now be updated to explain how contributors can run the test suite using these local services.

Proposed changes:

  1. Update local service setup

    In the documentation for starting the local services, add the additional permission setup steps required before running docker compose, as implemented in #1697.

  2. Update the testing guide

    Extend the test guide with instructions on how to run pytest against the local services.
    This requires setting the environment variable: OPENML_USE_LOCAL_SERVICES

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationGood First IssueIssues suitable for people new to contributing to openml-python!

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions