Modules

The Mr. Smith module system allows developers to create, share, and reuse template structures in a modular way. These modules are independent repositories that contain templates, builders, and pipelines.

Structure

The structure of a module in Mr. Smith is the same as you are already familiar with. Any GitHub repository with a .mr-smith folder at the root containing at least one pipeline can become a module if you add a file called mr-config.yaml in the root of the repository.

The mr-config.yaml file should follow the following format:

description: My module # Module description
version: 1.0.0 # Module version

Adding a module

To add a Mr. Smith module to your project, run the command mr module add -repository myorganization/myrepository. Or if you prefer, you can simply type mr module add and choose one of our official modules.

When adding a module to your project, Mr. Smith will copy the module repository into the .mr-smith folder. To manage the modules, Mr. Smith will also create a file called mr-modules.yaml, which will be automatically updated whenever a module is added or removed from your project.

Check the complete documentation of the mr module add command here.

Calling a run from a module

Check the complete documentation of the mr run command here.

Removing a module

Check the complete documentation of the mr module rm command here.