8000 GitHub - mutms/mudev: Moodle/MuTMS development tool · GitHub
[go: up one dir, main page]

Skip to content
mutmsPublic

About

Moodle/MuTMS development tool

Resources

Stars

0 stars

Watchers

1 watching

Forks

Latest commit

 

History

39 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mudev — Moodle/MuTMS development tool

mudev prepares the source code of a Moodle site. You give it a recipe — a small YAML file that says what the site is made of: which Moodle version, which plugins, which releases — and mudev fetches all of it and arranges it into a ready-to-use code tree, every plugin in its right place. It was written for developing MuTMS plugins.

Where you'll meet it

mudev is plumbing: most people never install it themselves, they meet it working inside something else.

  • mpd — the Moodle plugin development environment. Its Linux VM ships mudev pre-installed, and developers use it there to set up and maintain their project workspaces.
  • mdl-demo — the try-Moodle-on-your-own-computer container. When you pick a Moodle version in its web UI, it is mudev that assembles the demo site's code behind the scenes.
  • CI — automated test pipelines use the standalone mudev binary to build the Moodle site trees that plugins are tested against.

mudev runs on Linux only. It prepares code for development, demos and testing; it does not run on production servers itself.

Installing it

On an mpd VM there is nothing to install: mudev and both catalogues are already there.

Anywhere else on Linux:

  1. Download the binary for your architecture (linux-amd64 or linux-arm64) from the releases page and put it on your PATH as mudev.

  2. Clone the two catalogues side by side:

    sudo install -d -o "$USER" /srv/extra
    git clone https://github.com/mutms/mdl-plugins.git /srv/extra/mdl-plugins
    git clone https://github.com/mutms/mdl-recipes.git /srv/extra/mdl-recipes

    mudev looks there by default. To keep them somewhere else, set MUDEV_PLUGINS_DIRECTORY and MUDEV_RECIPES_DIRECTORY (see docs/usage.md).

Using it yourself

Two commands cover most of what people need:

Clone a recipe into a directory and you get a ready-to-use Moodle tree — core plus every plugin checked out at its place:

mudev clone mutms/release/5.2.4.01 /srv/projects/mutms52

The recipe is either a catalogue identifier (vendor/stream/version) or a path to a recipe file. Browse the available recipes. clone is idempotent — run it again to resume an interrupted clone or to pick up plugins the recipe has gained. Moodle core borrows its history from the local mirror /srv/extra/moodle.git, so a new workspace downloads and stores only what upstream Moodle does not have.

Add a plugin to a workspace you already have, and it lands at the right place on the right branch for that Moodle:

mudev recipe add mutms/tool_mulib

From there mudev manages the whole set of checkouts as one workspace — listing their state, fetching, pulling, pushing, exporting a portable recipe, packing a deployable .tgz (mudev production export), and more. See docs/usage.md for the full command reference and git workflow.

Catalogues

Plugin metadata and recipes live in their own repositories, so they can be read by tools other than mudev — a composer-based assembler, a catalogue website — and extended without changing this one. Both are CC0 (public domain): reuse freely — keeping an entry's contributed_by credit is a courtesy, not a condition.

  • mdl-plugins — <vendor>/<package>.yaml, what a plugin is: where it installs, where the code is, which git branch serves which Moodle version. Identifier mutms/tool_mulib.
  • mdl-recipes — <vendor>/<stream>/<version>.yaml, what a site is. Identifier mutms/release/5.2.4.01.

A recipe does not have to come from a catalogue at all: mudev clone ./mysite.yaml takes a self-contained file, which is what mudev recipe export produces.

Docs

AI disclosure

Majority of this project was written with the help of Claude (Anthropic). Everything it produced was reviewed, corrected where needed and accepted by a human maintainer before being committed; the design decisions and the final state of the code are the maintainers'.

License

GPL-3.0-or-later — see LICENSE.txt.

Trademarks

Moodle™ is a registered trademark of Moodle Pty Ltd. This project is independent and is not affiliated with, endorsed by, or sponsored by Moodle Pty Ltd. "Moodle" is used here only to refer to the genuine Moodle software (e.g. an unmodified MOODLE_502_STABLE tree with additional plugins).

About

Moodle/MuTMS development tool

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages

0