prometa.git.gitlab.ci package

Subpackages

• prometa.git.gitlab.ci.python package
  • Submodules
  • prometa.git.gitlab.ci.python.pylint module
    • PylintCIJobManager
      • PylintCIJobManager.NAME
      • PylintCIJobManager.enabled
      • PylintCIJobManager.manage()
  • prometa.git.gitlab.ci.python.register_python_package module
    • RegisterPythonPackageCIJobManager
      • RegisterPythonPackageCIJobManager.NAME
      • RegisterPythonPackageCIJobManager.manage()
  • Module contents

Submodules

prometa.git.gitlab.ci.ci_job_manager module

Base class for each CI job manager.

class prometa.git.gitlab.ci.ci_job_manager.CIJobManager(gitlab_ci)

Bases: Registrable

Registrable base class for each CI job manager.

NAME = None

__init__(gitlab_ci)

Parameters:

gitlab_ci – A GitLabCI instance.

property enabled

The job’s name is in the gitlab.enabled_ci_jobs list in the configuration file.

manage()

Manage the job in the CI file according to current project conditions and configuration settings.

prometa.git.gitlab.ci.pages module

Manage the pages job.

class prometa.git.gitlab.ci.pages.PagesCIJobManager(gitlab_ci)

Bases: CIJobManager

This does not create the pages job. It only updates it to set the following fields: “artifacts”, “only” and “stage”.

NAME = 'pages'

manage()

Manage the job in the CI file according to current project conditions and configuration settings.

prometa.git.gitlab.ci.release_job module

Manage the release_job job.

class prometa.git.gitlab.ci.release_job.ReleaseJobCIJobManager(gitlab_ci)

Bases: CIJobManager

Add a release job that triggers when Git release tags are pushed. The release tag regular expression can be set in the configuration file.

NAME = 'release_job'

manage()

Manage the job in the CI file according to current project conditions and configuration settings.

Module contents

Manage the CI file.

class prometa.git.gitlab.ci.CIJobManager(gitlab_ci)

Bases: Registrable

Registrable base class for each CI job manager.

NAME = None

__init__(gitlab_ci)

Parameters:

gitlab_ci – A GitLabCI instance.

property enabled

The job’s name is in the gitlab.enabled_ci_jobs list in the configuration file.

manage()

Manage the job in the CI file according to current project conditions and configuration settings.

class prometa.git.gitlab.ci.GitLabCI(host, path='.gitlab-ci.yml')

Bases: object

Wrapper around the gitlab-ci file.

__init__(host, path='.gitlab-ci.yml')

Parameters:

• host – A GitLabHost instance.

• path – The path to the gitlab-ci file, relative to the repository root directory.

add_stages()

Add the list of stages for all added jobs.

add_tags()

Add runner tags. This will deduplicate tags and also ensure that jobs using the same tags reference each other in the YAML output.

property data

The CI configuration data.

get_ci_job_manager(name)

Get an instance of the named CIJobManager subclass.

load()

Load the file data.

Returns:

The loaded data, or an empty dict if the file does not exist.

manage()

Manage the configured jobs in the CI file.

property project

The Project instance or subclass.