Skip to content

Conversation

@sidkos
Copy link
Owner

@sidkos sidkos commented Oct 4, 2025

This pull request introduces a comprehensive overhaul to the CI/CD pipeline and project documentation, with a strong emphasis on supporting robust component testing and clarifying the separation of deliverables. The changes add a reusable GitHub Actions workflow for component tests, update the Dockerfile to use a startup script, and improve documentation for both the main project and the dp-client client. Additionally, the dp-client package is refactored for clearer imports and versioning.

CI/CD and Testing Improvements

  • Added a reusable GitHub Actions workflow for component tests (.github/workflows/component_tests.yml), which runs server and database in containers, waits for readiness, installs dp-client, and executes tests. This enables isolated, reliable component testing in CI.
  • Integrated the new component test workflow into the main CI/CD pipeline (.github/workflows/ci_cd.yml), ensuring component tests run automatically after building the server image.
  • Updated static code analysis and component test steps to use the new build_and_install_dp_client.sh script for installing the client, replacing the previous OpenAPI client install script.

Containerization

  • Changed the Dockerfile to use a dedicated startup script (start_server_in_container.sh) for running the server, improving maintainability and flexibility.

Documentation and Project Structure

  • Rewrote the main README.md to provide a project overview, clarify the separation of server, client, and test client, document requirements files, and explain CI/CD flows and release strategy.
  • Added a dedicated dp-client/README.md describing its architecture, usage, configuration, requirements, and best practices for release and repository separation.

dp-client Package Refactoring

  • Refactored dp-client imports in dp_client/__init__.py and dp_client/api/__init__.py for clearer API exposure and added dynamic version detection for the package. [1] [2]

@sidkos sidkos self-assigned this Oct 4, 2025
@sidkos sidkos merged commit f5baaa4 into main Oct 4, 2025
@sidkos sidkos deleted the add-dp-client branch October 5, 2025 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants