Module `continuous_delivery_scripts.plugins.ci`

Plugin for CI projects.

Classes

class CI

Expand source code

class CI(BaseLanguage):
    """Specific actions for a CI project."""

    def package_software(self, mode: CommitType, version: str) -> None:
        """Nothing to do."""
        pass

    def generate_code_documentation(self, output_directory: Path, module_to_document: str) -> None:
        """Generates the code documentation."""
        pass

    def get_related_language(self) -> str:
        """Gets the related language."""
        return get_language_from_file_name(__file__)

    def get_version_tag(self, version: str) -> str:
        """Gets tag based on version."""
        cleansed_version = version.strip().lstrip("v")
        return f"v{cleansed_version}"

    def release_package_to_repository(self, mode: CommitType, version: str) -> None:
        """No operation."""
        pass

    def check_credentials(self) -> None:
        """Checks any credentials."""
        super().check_credentials()
        configuration.get_value(ConfigurationVariable.GIT_TOKEN)

    def can_add_licence_headers(self) -> bool:
        """States that licence headers can be added."""
        return True

    def can_get_project_metadata(self) -> bool:
        """States whether project metadata can be retrieved."""
        return False

    def get_current_spdx_project(self, skip_dependency_download: bool = False) -> Optional["SpdxProject"]:
        """Gets current SPDX description."""
        # TODO
        return None

    def should_clean_before_packaging(self) -> bool:
        """States whether the repository must be cleaned before packaging happens."""
        return True

Specific actions for a CI project.

Ancestors

BaseLanguage
abc.ABC

Subclasses

GitHubActions

Methods

def can_add_licence_headers(self) ‑> bool

Expand source code

def can_add_licence_headers(self) -> bool:
    """States that licence headers can be added."""
    return True

States that licence headers can be added.

def check_credentials(self) ‑> None

Expand source code

def check_credentials(self) -> None:
    """Checks any credentials."""
    super().check_credentials()
    configuration.get_value(ConfigurationVariable.GIT_TOKEN)

Checks any credentials.

def get_current_spdx_project(self, skip_dependency_download: bool = False) ‑> SpdxProject | None

Expand source code

def get_current_spdx_project(self, skip_dependency_download: bool = False) -> Optional["SpdxProject"]:
    """Gets current SPDX description."""
    # TODO
    return None

Gets current SPDX description.

def get_related_language(self) ‑> str

Expand source code

def get_related_language(self) -> str:
    """Gets the related language."""
    return get_language_from_file_name(__file__)

Gets the related language.

def get_version_tag(self, version: str) ‑> str

Expand source code

def get_version_tag(self, version: str) -> str:
    """Gets tag based on version."""
    cleansed_version = version.strip().lstrip("v")
    return f"v{cleansed_version}"

Gets tag based on version.

def package_software(self, mode: CommitType, version: str) ‑> None

Expand source code

def package_software(self, mode: CommitType, version: str) -> None:
    """Nothing to do."""
    pass

Nothing to do.

def release_package_to_repository(self, mode: CommitType, version: str) ‑> None

Expand source code

def release_package_to_repository(self, mode: CommitType, version: str) -> None:
    """No operation."""
    pass

No operation.

Inherited members

BaseLanguage: