nmk_github.action
=================

.. py:module:: nmk_github.action

.. autoapi-nested-parse::

   Github actions handling module



Classes
-------

.. autoapisummary::

   nmk_github.action.ActionFileBuilder
   nmk_github.action.PythonVersionsResolver


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

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

   Bases: :py:obj:`nmk_base.common.TemplateBuilder`


   Builder used to handle github workflow generation


   .. py:method:: build(python_versions: list[str], command: str, images: list[str], build_steps: list[dict[str, str]], publish_steps: list[dict[str, str]])

      Called by the **gh.actions** to generate the Github workflow file.

      :param python_versions: List of used python versions
      :param command: Build command for workflow
      :param images: List of used Github images
      :param build_steps: List of extra build steps to be generated
      :param publish_steps: List of extra publish steps to be generated



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

   Bases: :py:obj:`nmk.model.resolver.NmkListConfigResolver`


   Resolution logic for **githubDetectedPythonVersions**


   .. py:method:: get_value(name: str) -> list[str]

      Resolves python version to be used in generated workflow file.

      Returns:

      * **githubPythonVersions** item value if not empty
      * otherwise **pythonSupportedVersions** item value if **nmk-python** plugin is used
      * otherwise an empty list

      :param name: item name
      :returns: resolved python versions list