.. _f-jenkinsserver: module ``jenkinshelper.jenkins_server`` ======================================= .. inheritance-diagram:: pyquickhelper.jenkinshelper.jenkins_server Short summary +++++++++++++ module ``pyquickhelper.jenkinshelper.jenkins_server`` Extends Jenkins Server from :epkg:`python-jenkins`. :githublink:`%|py|5` Classes +++++++ +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ | class | truncated documentation | +=============================================================================+===================================================================================+ | :class:`JenkinsExt ` | Extensions for the :epkg:`Jenkins` server based on module :epkg:`python-jenkins`. | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ Functions +++++++++ +------------------------------------------------------------------------------------------------------------------+-------------------------+ | function | truncated documentation | +==================================================================================================================+=========================+ | :func:`_modified_linux_jenkins ` | | +------------------------------------------------------------------------------------------------------------------+-------------------------+ | :func:`_modified_linux_jenkins_any ` | | +------------------------------------------------------------------------------------------------------------------+-------------------------+ | :func:`_modified_windows_jenkins ` | | +------------------------------------------------------------------------------------------------------------------+-------------------------+ | :func:`_modified_windows_jenkins_27 ` | | +------------------------------------------------------------------------------------------------------------------+-------------------------+ | :func:`_modified_windows_jenkins_any ` | | +------------------------------------------------------------------------------------------------------------------+-------------------------+ Properties ++++++++++ +---------------------------------------------------------------------------------+-------------------------+ | property | truncated documentation | +=================================================================================+=========================+ | :meth:`Engines ` | | +---------------------------------------------------------------------------------+-------------------------+ Static Methods ++++++++++++++ +-----------------------------------------------------------------------------------------------+------------------------------------+ | staticmethod | truncated documentation | +===============================================================================================+====================================+ | :meth:`get_cmd_custom ` | Custom script for :epkg:`Jenkins`. | +-----------------------------------------------------------------------------------------------+------------------------------------+ | :meth:`hash_string ` | Hashes a string. | +-----------------------------------------------------------------------------------------------+------------------------------------+ Methods +++++++ +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +============================================================================================================================================+=====================================================================================================================================================================================+ | :py:meth:`__init__ ` | | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_setup_jenkins_server_job_iteration ` | | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_setup_jenkins_server_modules_loop ` | | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`adjust_scheduler ` | Adjusts the scheduler to avoid having two jobs starting at the same time, jobs are delayed by an hour, two hours, ... | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`create_job_template ` | Adds a job to the :epkg:`Jenkins` server. | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`delete_all_jobs ` | Deletes all jobs permanently. | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`delete_job ` | Deletes :epkg:`Jenkins` job permanently. | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`extract_requirements ` | Extracts the requirements for a job. | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_cmd_standalone ` | Custom command for :epkg:`Jenkins` (such as updating conda) | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_engine_from_job ` | Extracts the engine from the job definition, it should be like ``[engine]``. | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_jenkins_job_name ` | Infers a name for the jenkins job. | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_jenkins_script ` | Builds the :epkg:`Jenkins` script for a module and its options. | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_jobs ` | Gets the list of all jobs recursively to the given folder depth, see `get_all_jobs `_. ... | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`jenkins_open ` | Overloads the same method from module :epkg:`python-jenkins` to replace string by bytes. | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`process_options ` | Postprocesses a script inserted in a job definition. | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`setup_jenkins_server ` | Sets up many jobs in :epkg:`Jenkins`. | +--------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.jenkinshelper.jenkins_server :members: :special-members: __init__ :show-inheritance: