Skip to content

release_env

ReleaseEnv

Bases: BaseModel

Object to store the release configuration.

Attributes:

Name Type Description
build_tag str

...
python_tag str

...
is_release bool

...
is_release_pr bool

...
is_hotfix_pr bool

...
workflow Workflow

...
Source code in m/ci/release_env.py 
11
12
13
14
15
16
17
18
19
class ReleaseEnv(BaseModel):
    """Object to store the release configuration."""

    build_tag: str
    python_tag: str
    is_release: bool
    is_release_pr: bool
    is_hotfix_pr: bool
    workflow: Workflow

get_release_env(config, env_vars, git_env)

Provide the release environment information.

Parameters:

Name Type Description Default
config Config

The m configuration.

 required
env_vars EnvVars

The environment variables.

 required
git_env GitEnv

The git environment.

 required

Returns:

Type Description
Res[ReleaseEnv]

A ReleaseEnv instance.
Source code in m/ci/release_env.py 
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
def get_release_env(
    config: Config,
    env_vars: EnvVars,
    git_env: GitEnv,
) -> Res[ReleaseEnv]:
    """Provide the release environment information.

    Args:
        config: The m configuration.
        env_vars: The environment variables.
        git_env: The git environment.

    Returns:
        A `ReleaseEnv` instance.
    """
    is_release = git_env.is_release(config)
    is_release_pr = git_env.is_release_pr(config)
    is_hotfix_pr = git_env.is_hotfix_pr(config)
    gh_latest = git_env.release.tag_name if git_env.release else ''
    if not config.uses_free_flow():
        check_result = _extra_checks(
            config,
            git_env,
            is_release_pr=is_release_pr,
            is_hotfix_pr=is_hotfix_pr,
        )
        if isinstance(check_result, Bad):
            return check_result
    return one_of(lambda: [
        ReleaseEnv(
            build_tag=build_tag,
            python_tag=python_tag,
            is_release=is_release,
            is_release_pr=is_release_pr,
            is_hotfix_pr=is_hotfix_pr,
            workflow=config.workflow,
        )
        for _ in _verify_version(
            config,
            git_env,
            gh_latest,
            is_release_pr=is_release_pr or is_hotfix_pr,
            is_release=is_release,
        )
        for build_tag in git_env.get_build_tag(config, env_vars.run_id)
        for python_tag in git_env.get_py_tag(config, env_vars.run_id)
    ])