Reference

branch_scheme(version, scmx_tool)

Versioning scheme: - Tags: Always exact (e.g., 1.2.3) - Main/Master Branch: {next_version}.dev{distance} - Feature Branches: {next_version}.{branch_name}.{distance}

Source code in src/setuptools_scmx/schemes.py

def branch_scheme(version: ScmVersion, scmx_tool: ScmxTool) -> str:
    """
    Versioning scheme:
    - Tags: Always exact (e.g., 1.2.3)
    - Main/Master Branch: {next_version}.dev{distance}
    - Feature Branches: {next_version}.{branch_name}.{distance}
    """
    env_scheme = scmx_tool.get_env_scheme()
    logger.debug("env scheme detected: %s", scmx_tool.env_scheme)
    env_version = env_scheme.build_version()
    if version.exact:
        return version.format_with("{tag}")

    base_version = env_version if env_version else guess_next_version(version)
    branch = env_scheme.build_branch_name() or version.branch
    version_distance = env_scheme.get_build_number() or version.distance

    label = scmx_tool.branch_scheme.get_release_label(branch)
    return f"{base_version}{label}.{version_distance}"

ReleaseLabel

Source code in src/setuptools_scmx/models.py

@attrs.define
class ReleaseLabel:
    name: LabelName = attrs.field(default="rc")
    branches: list[str] = attrs.field(factory=lambda: ["master", "main"])

    def match(self, branch_name: str | None) -> LabelName | None:
        """
        Checks if the given branch_name matches any of the patterns in self.branches.
        If a match is found, returns the label name; otherwise, returns None.
        Assumes `self.branches` can contain regular expression patterns.
        """
        if branch_name is None:
            return None
        # Iterate through branch patterns and return the label name on the first match.
        if any(re.match(pattern, branch_name) for pattern in self.branches):
            return self.name
        return None

match(branch_name)

Checks if the given branch_name matches any of the patterns in self.branches. If a match is found, returns the label name; otherwise, returns None. Assumes self.branches can contain regular expression patterns.

Source code in src/setuptools_scmx/models.py

def match(self, branch_name: str | None) -> LabelName | None:
    """
    Checks if the given branch_name matches any of the patterns in self.branches.
    If a match is found, returns the label name; otherwise, returns None.
    Assumes `self.branches` can contain regular expression patterns.
    """
    if branch_name is None:
        return None
    # Iterate through branch patterns and return the label name on the first match.
    if any(re.match(pattern, branch_name) for pattern in self.branches):
        return self.name
    return None

branch_scheme(version, scmx_tool)

Versioning scheme: - Tags: Always exact (e.g., 1.2.3) - Main/Master Branch: {next_version}.dev{distance} - Feature Branches: {next_version}.{branch_name}.{distance}

Source code in src/setuptools_scmx/schemes.py

def branch_scheme(version: ScmVersion, scmx_tool: ScmxTool) -> str:
    """
    Versioning scheme:
    - Tags: Always exact (e.g., 1.2.3)
    - Main/Master Branch: {next_version}.dev{distance}
    - Feature Branches: {next_version}.{branch_name}.{distance}
    """
    env_scheme = scmx_tool.get_env_scheme()
    logger.debug("env scheme detected: %s", scmx_tool.env_scheme)
    env_version = env_scheme.build_version()
    if version.exact:
        return version.format_with("{tag}")

    base_version = env_version if env_version else guess_next_version(version)
    branch = env_scheme.build_branch_name() or version.branch
    version_distance = env_scheme.get_build_number() or version.distance

    label = scmx_tool.branch_scheme.get_release_label(branch)
    return f"{base_version}{label}.{version_distance}"