Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Docker Support and Makefile for Development, Linting, and Fixing #14

Merged
merged 20 commits into from
Oct 25, 2024

Conversation

erseco
Copy link
Collaborator

@erseco erseco commented Oct 20, 2024

This PR introduces significant improvements to ease the development workflow for the Moodle ExeSCORM plugin. Below are the key changes:

Key Changes:

  1. Docker Integration:

    • Added docker-compose.yml to use exelearning-web and alpine-moodle containers for development.
    • The containers are binded to the local directory, ensuring that any changes in the code are reflected immediately in the deployed system.
    • This allows developers to work in an isolated environment that mimics the production setup, enhancing development efficiency and consistency.
  2. Makefile:

    • Added a Makefile with multiple commands to streamline common development tasks:
      • up, upd, down, and build for managing Docker containers.
      • install-deps, lint, fix, test, phpmd, and behat commands to easily manage Composer dependencies, linting, fixing, testing, and PHP Mess Detector.
      • help command to display available commands in the Makefile.
  3. Code Style Fixes:

    • Automatically fixed several coding style issues using phpcbf according to Moodle’s coding standards.
    • These fixes include handling arrays with short syntax and resolving multiple docblock issues.
  4. Removal of PHP 7.1 Support:

    • Removed testing support for PHP 7.1 in CI as it has reached its end of life and is no longer supported.
  5. Miscellaneous Fixes:

    • Resolved some lint and pipeline issues.
    • Corrected HTML validation errors and updated PHPDoc tags in various files.

Benefits:

  • The new Docker setup simplifies development and ensures consistency across environments.
  • The Makefile streamlines the development process, making it easier to manage dependencies, test code, and fix linting issues.
  • Code quality has been improved with automated fixes and updated documentation.

@erseco erseco requested a review from pabloamayab October 20, 2024 08:54
@erseco erseco self-assigned this Oct 20, 2024
Copy link
Collaborator

@pabloamayab pabloamayab left a comment

Choose a reason for hiding this comment

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

Great job!

@pabloamayab pabloamayab reopened this Oct 25, 2024
@pabloamayab pabloamayab merged commit 534f9b6 into main Oct 25, 2024
0 of 24 checks passed
@pabloamayab pabloamayab deleted the development-toolbox branch October 25, 2024 07:46
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