Skip to content

Branch naming

branch_naming

Branch naming convention for ticket-driven workflows.

CONVENTIONAL_COMMIT_FORMAT = '<type>[(scope)][!]: <description>' module-attribute

Human-readable expected Conventional Commit summary format.

branch_name_from_ticket(ticket_id, title, labels)

Build a deterministic branch name from ticket metadata.

Produces names in the format <type>/<TICKET_ID>-<slug> where type is derived from the ticket labels.

Parameters:

Name Type Description Default
ticket_id str

Ticket identifier (e.g. "AXM-42").

 required
title str

Ticket title used to generate the slug.

 required
labels list[str]

Ticket labels used to determine the branch type.

 required

Returns:

Type Description
str

A URL-safe branch name.
Source code in packages/axm-git/src/axm_git/core/branch_naming.py
Python
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def branch_name_from_ticket(
    ticket_id: str,
    title: str,
    labels: list[str],
) -> str:
    """Build a deterministic branch name from ticket metadata.

    Produces names in the format ``<type>/<TICKET_ID>-<slug>`` where
    *type* is derived from the ticket labels.

    Args:
        ticket_id: Ticket identifier (e.g. ``"AXM-42"``).
        title: Ticket title used to generate the slug.
        labels: Ticket labels used to determine the branch type.

    Returns:
        A URL-safe branch name.
    """
    branch_type = _resolve_type(labels, title)
    slug = slugify(title)
    return f"{branch_type}/{ticket_id}-{slug}"

is_conventional_commit(message)

Return whether message matches the Conventional Commit format.

A message is conventional when it starts with type: or type(scope): (an optional breaking ! marker is allowed before the colon, e.g. feat!: or fix(scope)!:) followed by a space. This is the single source of truth shared by branch-type inference and the git_commit validation path.

Parameters:

Name Type Description Default
message str

Commit summary line to validate.

 required

Returns:

Type Description
bool

True if the message is conventionally formatted.
Source code in packages/axm-git/src/axm_git/core/branch_naming.py
Python
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
def is_conventional_commit(message: str) -> bool:
    """Return whether *message* matches the Conventional Commit format.

    A message is conventional when it starts with ``type:`` or
    ``type(scope):`` (an optional breaking ``!`` marker is allowed before
    the colon, e.g. ``feat!:`` or ``fix(scope)!:``) followed by a space.
    This is the single source of truth shared by branch-type inference
    and the ``git_commit`` validation path.

    Args:
        message: Commit summary line to validate.

    Returns:
        ``True`` if the message is conventionally formatted.
    """
    return _CONVENTIONAL_PREFIX_RE.match(message) is not None

slugify(title, *, max_len=40)

Convert a title string into a URL-safe slug.

Lowercases the input, replaces non-alphanumeric characters with hyphens, collapses consecutive hyphens, and strips leading/trailing hyphens.

Parameters:

Name Type Description Default
title str

The title to slugify.

 required
max_len int

Maximum length of the slug (default 40). Truncation prefers word boundaries when possible.

 40

Returns:

Type Description
str

A sanitized slug, or "untitled" if the title is empty or
str

contains only special characters.
Source code in packages/axm-git/src/axm_git/core/branch_naming.py
Python
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def slugify(title: str, *, max_len: int = 40) -> str:
    """Convert a title string into a URL-safe slug.

    Lowercases the input, replaces non-alphanumeric characters with hyphens,
    collapses consecutive hyphens, and strips leading/trailing hyphens.

    Args:
        title: The title to slugify.
        max_len: Maximum length of the slug (default 40). Truncation
            prefers word boundaries when possible.

    Returns:
        A sanitized slug, or ``"untitled"`` if the title is empty or
        contains only special characters.
    """
    slug = title.lower()
    slug = re.sub(r"[^a-z0-9]+", "-", slug)
    slug = slug.strip("-")

    if not slug:
        return "untitled"

    if len(slug) <= max_len:
        return slug

    # Truncate at word boundary
    truncated = slug[:max_len]
    last_hyphen = truncated.rfind("-")
    if last_hyphen > 0:
        truncated = truncated[:last_hyphen]

    return truncated.rstrip("-")