Modularity/Getting Started/New-Module-Process

Adding and building a module for Fedora

This document describes the process of adding a new module to the Fedora Modularity project, how to build it locally and how to build it in Fedora infrastructure

Process and policy for how to add a module to Fedora

TBD

Write a new modulemd file

A modulemd file is a yaml file that contains the module metadata like description, license and dependencies. The sample file in the upstream git repository of modulemd contains a complete documentation of the required and optional yaml tags.

The Modularity team uses a shorter modulemd file to test builds, but it can also be used as a base for new modules. Another good example is base-runtime.yml

There is a python program that checks modulemd files for errors. You need to install some packages to use this:

• python2-aexpect - dependency for python-avocado
• python2-avocado - avocado testing framework
• python2-modulemd - Module metadata manipulation library
• python-enchant - spell checker library (needed only for check_modulemd.py)
• hunspell-en-US - English dictionary (needed only for check_modulemd.py)

Then run

./run-checkmmd.sh /path/to/modulemd/file