.. _mash_directive:


mash_directive - create a YUM repository from RPM packages using mash
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 0.4

Take a directory containing RPM packages and run ``mash`` command on it,
which creates YUM repository metadata.

This internally calls ``createrepo`` (which can be used separately through the
:ref:`createrepo directive <createrepo_directive>`), and then ``mash`` to
finish the process. Mash will handle creating delta RPMs (if requested)
and it will handle creating multilib repository metadata (which is currently
supported just for ``x86_64`` architecture).

.. note:: Beware, when creating multilib repositories, the non-multilib
  packages (``i386`` packages which shoudn't be part of the ``x86_64``
  repository) are deleted from the directory.


Parameters
----------

.. raw:: html

    <table class="rawhtml" border=1 cellpadding=4>
    <tr>
    <th class="head">parameter</th>
    <th class="head">required</th>
    <th class="head">description</th>
    <th class="head">type</th>
    <th class="head">default</th>
    <th class="head">choices</th>
    </tr>
            <tr>
    <td class="bold"><p>arch</p></td>
    <td>yes</td>
    <td><p>list of architectures for which to create YUM metadata</p></td>
    <td><p>list of str</p></td>
    <td></td>
    <td><ul></ul></td>
    </tr>
            <tr>
    <td class="bold"><p>dodelta</p></td>
    <td>no</td>
    <td><p>whether to create delta RPMs during the mash process</p></td>
    <td><p>bool</p></td>
    <td><p>False</p></td>
    <td><ul><li><p>True</p></li><li><p>False</p></li></ul></td>
    </tr>
            <tr>
    <td class="bold"><p>outdir</p></td>
    <td>no</td>
    <td><p>absolute or relative path to an output directory, where repository should be created. If not specified, then <tt class="docutils literal">rpmdir</tt> is used as an output directory. <tt class="docutils literal">outdir</tt> will be created automatically if not present.</p></td>
    <td><p>str</p></td>
    <td><p>None</p></td>
    <td><ul></ul></td>
    </tr>
            <tr>
    <td class="bold"><p>rpmdir</p></td>
    <td>yes</td>
    <td><p>absolute or relative path to the directory containing RPM files (the task directory is considered the current working directory)</p></td>
    <td><p>str</p></td>
    <td></td>
    <td><ul></ul></td>
    </tr>
        </table>

Return Values
-------------

(``string``) path to the directory where the repository has been created


Exceptions
----------

* :class:`.TaskotronDirectiveError`: if ``createrepo`` returns a non-zero exit
  code



Examples
--------


First, download all required RPMs, then create a YUM repository in that
directory::

    - name: download koji tag
      koji:
          action: download_tag
          koji_tag: ${koji_tag}
          arch: ${arch}
          target_dir: "${workdir}/downloaded_tag/"

    - name: mash downloaded rpms
      mash:
          rpmdir: "${workdir}/downloaded_tag/"
          dodelta: False
          arch: ${arch}