Skip to content

Conversation

@germa89
Copy link
Collaborator

@germa89 germa89 commented Nov 14, 2025

Description

This PR reorganizes the docker/ directory into a cleaner, more maintainable structure by separating files based on their purpose.

Changes

New Directory Structure

The docker/ directory has been reorganized into three subdirectories:

  • docker/build/ - Contains files for building MAPDL Docker images:

    • Dockerfile
    • .dockerignore
    • make_container.rst (moved from docker/)
  • docker/run/ - Contains files for running MAPDL containers:

    • docker-compose.yml (cleaned up to focus on MAPDL/DPF services with external license)
    • README.md (comprehensive usage documentation)
    • Template files for local license server setup (gitignored)
  • docker/testing/ - Contains testing-related files (already existed):

    • README.md (new documentation)

Key Improvements

  1. Better organization: Files are now grouped by functionality (build, run, test)
  2. Cleaner docker-compose: The main docker-compose.yml focuses on MAPDL and DPF services with external license servers
  3. Template support: Added templates for local license server configuration (which are gitignored)
  4. Documentation: Added README files in each subdirectory explaining purpose and usage
  5. Named compose project: Added name: pymapdl to docker-compose.yml for cleaner container naming

Documentation Updates

  • Updated doc/source/getting_started/make_container.rst to reference new file locations
  • Updated doc/source/links.rst with new docker-compose.yml path
  • All references to moved files have been updated

Files Moved

  • docker/Dockerfiledocker/build/Dockerfile
  • docker/.dockerignoredocker/build/.dockerignore
  • docker/make_container.rstdocker/build/make_container.rst
  • docker/docker-compose.ymldocker/run/docker-compose.yml

Benefits

  • Easier to find relevant files based on use case
  • Clearer separation of concerns
  • Better support for both public (repo) and private (local) configurations
  • Improved documentation with directory-specific READMEs

… docs

- Add docker/run/docker-compose.yml and docker/run/README.md for runtime configs
- Remove legacy docker/Dockerfile, docker/.dockerignore and old docker/make_container.rst
- Update documentation to reference new paths:
  - change include in make_container.rst to docker/build/make_container.rst
  - update links.rst to point to docker/run/docker-compose.yml
Copilot AI review requested due to automatic review settings November 14, 2025 18:10
@germa89 germa89 requested a review from a team as a code owner November 14, 2025 18:10
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR reorganizes the docker/ directory to improve maintainability and clarity by separating files based on their purpose: building images, running containers, and testing. The restructuring groups related files into docker/build/, docker/run/, and docker/testing/ subdirectories, updates the docker-compose configuration to be more focused and production-ready, and adds comprehensive documentation through README files in each subdirectory.

Key Changes

  • Relocated Docker build files (Dockerfile, .dockerignore, make_container.rst) to docker/build/
  • Moved docker-compose configuration to docker/run/ with simplified service definitions
  • Enhanced docker-compose.yml with named project, cleaner service profiles, and improved documentation
  • Updated all documentation references to reflect new file locations

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docker/run/docker-compose.yml New docker-compose configuration with external license server support, named project, and cleaner service definitions
docker/run/README.md New documentation explaining usage patterns, available services, profiles, and environment variables
docker/make_container.rst Removed file (moved to docker/build/)
docker/docker-compose.yml Removed file (relocated to docker/run/)
docker/Dockerfile Removed file (relocated to docker/build/)
docker/.dockerignore Removed file (relocated to docker/build/)
doc/source/links.rst Updated link to docker-compose.yml to point to new location
doc/source/getting_started/make_container.rst Updated include path for make_container.rst to new build directory location

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions github-actions bot added CI/CD Related with CICD, Github Actions, etc documentation Documentation related (improving, adding, etc) enhancement Improve any current implemented feature labels Nov 14, 2025
@germa89 germa89 changed the title Refactor docker directory structure refactor: docker directory structure Nov 14, 2025
@codecov
Copy link

codecov bot commented Nov 17, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.34%. Comparing base (45ead1e) to head (9e869b2).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4306      +/-   ##
==========================================
+ Coverage   91.31%   91.34%   +0.03%     
==========================================
  Files         193      193              
  Lines       15742    15742              
==========================================
+ Hits        14375    14380       +5     
+ Misses       1367     1362       -5     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89 germa89 enabled auto-merge (squash) November 17, 2025 16:58
@germa89
Copy link
Collaborator Author

germa89 commented Nov 17, 2025

@pyansys-ci-bot LGTM.

Copy link
Contributor

@pyansys-ci-bot pyansys-ci-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Approving this PR because germa89 said so in here 😬

LGTM

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

Labels

CI/CD Related with CICD, Github Actions, etc documentation Documentation related (improving, adding, etc) enhancement Improve any current implemented feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants