Skip to content

Conversation

@sepideh-abedini
Copy link
Collaborator

Summary

Adding support for Docker to the project for easier installation and setup. This way, users can run MaskSQL with a single command without any installation or setup.

Clickup Ticket(s): https://app.clickup.com/t/868gqbcfz

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • [ x] ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📝 Documentation update
  • 🔧 Refactoring (no functional changes)
  • ⚡ Performance improvement
  • 🧪 Test improvements
  • 🔒 Security fix

Changes Made

  • Added Docker file to build MaskSQL image that includes all necessary libraries.
  • Added docker-compose file to specify the runtime setup of the container
  • Added local docker-compose file for developers who want to build the image locally and experiment with it
  • Added Github actions workflow to build and publish the image for both ARM/AMD64 platforms on the ghcr.io

Testing

  • [ x] Tests pass locally (uv run pytest tests/)
  • [x ] Type checking passes (uv run mypy <src_dir>)
  • [ x] Linting passes (uv run ruff check src_dir/)
  • Manual testing performed (describe below)

Checklist

  • [ x] Code follows the project's style guidelines
  • [ x] Self-review of code completed
  • [ x] Documentation updated (if applicable)
  • [ x] No sensitive information (API keys, credentials) exposed

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