Skip to content

versioning

VersionInputs

Bases: BaseModel

Container with information to generate a version.

Attributes:

Name Type Description
version_prefix str

...
version str

...
run_id str | None

...
sha str

...
pr_number int | None

...
branch str

...
is_release bool

...
is_release_pr bool

...
is_hotfix_pr bool

...
Source code in m/ci/versioning.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class VersionInputs(BaseModel):
    """Container with information to generate a version."""

    # '0.0.0-' or 'a.b.c-' or '': Necessary for pr builds
    version_prefix: str

    # the version in the configuration
    version: str

    # unique number for each run in CI environment
    run_id: str | None

    # current commit sha
    sha: str

    pr_number: int | None

    # The build git branch
    branch: str

    is_release: bool
    is_release_pr: bool
    is_hotfix_pr: bool

build_m_tag(ver_input, config)

Build an valid "M_TAG".

Parameters:

Name Type Description Default
ver_input VersionInputs

The inputs to create the tag.

 required
config Config

The m configuration.

 required

Returns:

Type Description
str

An m tag that can be used to version npm and docker packages.
Source code in m/ci/versioning.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def build_m_tag(ver_input: VersionInputs, config: Config) -> str:
    """Build an valid "M_TAG".

    Args:
        ver_input: The inputs to create the tag.
        config: The m configuration.

    Returns:
        An m tag that can be used to version npm and docker packages.
    """
    prefix = '' if config.uses_free_flow() else f'{ver_input.version_prefix}-'
    pr_number = ver_input.pr_number
    run_id = ver_input.run_id
    if not run_id:
        return f'{prefix}local.{ver_input.sha}'
    if ver_input.is_release:
        return ver_input.version
    if pr_number:
        nprefix = ''
        if ver_input.is_release_pr:
            nprefix = 'rc'
        elif ver_input.is_hotfix_pr:
            nprefix = 'hotfix'
        if nprefix:
            return f'{ver_input.version}-{nprefix}{pr_number}.b{run_id}'
        return f'{prefix}pr{pr_number}.b{run_id}'
    return f'{prefix}{ver_input.branch}.b{run_id}'

build_py_tag(ver_input, config)

Build a valid python version.

The configuration object is provided since python does not accept using names of branches in the versions. For this reason we will map

Parameters:

Name Type Description Default
ver_input VersionInputs

The inputs to create the version.

 required
config Config

The m configuration.

 required

Returns:

Type Description
str

A valid python tag.
Source code in m/ci/versioning.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
def build_py_tag(ver_input: VersionInputs, config: Config) -> str:
    """Build a valid python version.

    The configuration object is provided since python does not accept using
    names of branches in the versions. For this reason we will map

    Args:
        ver_input: The inputs to create the version.
        config: The m configuration.

    Returns:
        A valid python tag.
    """
    prefix = ver_input.version_prefix
    pr_number = ver_input.pr_number
    run_id = ver_input.run_id
    now = int(time.time())
    if not run_id:
        return f'{prefix}a0+b{now}'
    if ver_input.is_release:
        return ver_input.version
    if pr_number:
        nprefix = ''
        if ver_input.is_release_pr or ver_input.is_hotfix_pr:
            nprefix = 'rc'
        if nprefix:
            return f'{ver_input.version}{nprefix}{pr_number}.dev{run_id}'
        return f'{prefix}b{pr_number}.dev{run_id}'
    nprefix = _get_py_branch_prefix(config, ver_input.branch)
    return f'{prefix}{nprefix}.dev{run_id}'