Module gcip.lib.rules

Functions

def not_on_branch(branch_name: str) ‑> Rule

Expand source code

def not_on_branch(branch_name: str) -> Rule:
    return Rule(if_statement=f'$CI_COMMIT_BRANCH != "{branch_name}"')

def not_on_main() ‑> Rule

Expand source code

def not_on_main() -> Rule:
    return not_on_branch("main")

def not_on_master() ‑> Rule

Expand source code

def not_on_master() -> Rule:
    return not_on_branch("master")

def on_branch(branch_name: str) ‑> Rule

Expand source code

def on_branch(branch_name: str) -> Rule:
    return Rule(if_statement=f'$CI_COMMIT_BRANCH == "{branch_name}"')

def on_main() ‑> Rule

Expand source code

def on_main() -> Rule:
    return on_branch("main")

def on_master() ‑> Rule

Expand source code

def on_master() -> Rule:
    return on_branch("master")

def on_merge_request_events() ‑> Rule

Expand source code

def on_merge_request_events() -> Rule:
    return Rule(if_statement='$CI_PIPELINE_SOURCE == "merge_request_event"')

def on_pipeline_trigger() ‑> Rule

Expand source code

def on_pipeline_trigger() -> Rule:
    """
    ```
    if: '$CI_PIPELINE_SOURCE == "pipeline"'
    ```

    From https://docs.gitlab.com/ee/ci/yaml/

    |pipeline|For multi-project pipelines created by using the API with CI_JOB_TOKEN, or the trigger keyword.|
    """
    return Rule(if_statement='$CI_PIPELINE_SOURCE == "pipeline"')

if: '$CI_PIPELINE_SOURCE == "pipeline"'

From https://docs.gitlab.com/ee/ci/yaml/

|pipeline|For multi-project pipelines created by using the API with CI_JOB_TOKEN, or the trigger keyword.|

def on_success() ‑> Rule

Expand source code

def on_success() -> Rule:
    return Rule(when=WhenStatement.ON_SUCCESS)

def on_tags() ‑> Rule

Expand source code

def on_tags() -> Rule:
    return Rule(if_statement="$CI_COMMIT_TAG")