nmk_workspace.builders
======================

.. py:module:: nmk_workspace.builders

.. autoapi-nested-parse::

   Nmk workspace plugin builders.



Classes
-------

.. autoapisummary::

   nmk_workspace.builders.SubProjectsBuilder


Module Contents
---------------

.. py:class:: SubProjectsBuilder(model: nmk.model.model.NmkModel)

   Bases: :py:obj:`nmk.model.builder.NmkTaskBuilder`


   Builder for sub-projects in the workspace tree.

   This builder is used to iterate on workspace sub-projects and trigger nmk build for each.


   .. py:method:: build(root: str, to_build_first: list[str], to_build: list[str], to_build_after: list[str], excluded: list[str], args: Union[list[str], str], ignore_failures: bool = False)

      Build specified tasks for each sub-project.

      :param root: Root path of the workspace
      :param to_build_first: List of sub-projects paths to build first
      :param to_build: List of all sub-projects paths to be built (including the ones in to_build_first and to_build_after)
      :param to_build_after: List of sub-projects paths to build after all the others
      :param excluded: List of sub-projects glob patterns to exclude from building
      :param args: List of nmk args to use for each sub-project
      :param ignore_failures: Whether to ignore failure of sub-project builds