Skip to content

Merge

merge

GitMergeTool — squash-merge a branch into a target branch.

GitMergeTool

Bases: AXMTool

Squash-merge a branch into a target branch and commit.

Checks out target_branch, runs git merge --squash <branch>, then commits the squashed changes (honouring the identity-profile system). Registered as git_merge via axm.tools entry point.

Source code in packages/axm-git/src/axm_git/tools/merge.py
Python
30
31
32
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
60
61
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
92
93
94
95
96
97
98
class GitMergeTool(AXMTool):
    """Squash-merge a branch into a target branch and commit.

    Checks out *target_branch*, runs ``git merge --squash <branch>``, then
    commits the squashed changes (honouring the identity-profile system).
    Registered as ``git_merge`` via axm.tools entry point.
    """

    domain = "git"
    tags = frozenset({"merge", "squash", "branch"})

    @property
    def name(self) -> str:
        """Tool name used for MCP registration."""
        return "git_merge"

    def execute(  # type: ignore[override]
        self,
        *,
        branch: str,
        target_branch: str = "main",
        message: str | None = None,
        path: str = ".",
        **kwargs: object,
    ) -> ToolResult:
        """Squash-merge *branch* into *target_branch*.

        Args:
            branch: The branch to merge in (required).
            target_branch: The branch to merge into (default ``main``).
            message: Commit message for the squash commit. Defaults to
                ``Merge <branch> (squash)``.
            path: Repository path.

        Returns:
            ToolResult with ``merged``, ``into`` and ``message`` on success.
        """
        resolved = Path(path).resolve()
        msg = message or f"Merge {branch} (squash)"
        try:
            check = run_git(["rev-parse", "--git-dir"], resolved)
            if check.returncode != 0:
                repo_err = not_a_repo_error(check.stderr, resolved)
                return ToolResult(
                    success=repo_err.success,
                    error=repo_err.error,
                    data=repo_err.data,
                    text=render_failure_text(error=repo_err.error or ""),
                )

            identity = resolve_identity(resolved)
            steps = [
                (["checkout", target_branch], f"checkout {target_branch}"),
                (["merge", "--squash", branch], "merge --squash"),
                (["commit", "-m", msg, *author_args(identity)], "commit"),
            ]
            for args, label in steps:
                failure = _run_step(args, resolved, label)
                if failure is not None:
                    return failure
        except subprocess.TimeoutExpired as exc:
            return timeout_error_result(exc)

        data: dict[str, object] = {
            "merged": branch,
            "into": target_branch,
            "message": msg,
        }
        return ToolResult(success=True, data=data, text=render_text(data))
name property

Tool name used for MCP registration.

execute(*, branch, target_branch='main', message=None, path='.', **kwargs)

Squash-merge branch into target_branch.

Parameters:

Name Type Description Default
branch str

The branch to merge in (required).

 required
target_branch str

The branch to merge into (default main).

 'main'
message str | None

Commit message for the squash commit. Defaults to Merge <branch> (squash).

 None
path str

Repository path.

 '.'

Returns:

Type Description
ToolResult

ToolResult with merged, into and message on success.
Source code in packages/axm-git/src/axm_git/tools/merge.py
Python
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
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
92
93
94
95
96
97
98
def execute(  # type: ignore[override]
    self,
    *,
    branch: str,
    target_branch: str = "main",
    message: str | None = None,
    path: str = ".",
    **kwargs: object,
) -> ToolResult:
    """Squash-merge *branch* into *target_branch*.

    Args:
        branch: The branch to merge in (required).
        target_branch: The branch to merge into (default ``main``).
        message: Commit message for the squash commit. Defaults to
            ``Merge <branch> (squash)``.
        path: Repository path.

    Returns:
        ToolResult with ``merged``, ``into`` and ``message`` on success.
    """
    resolved = Path(path).resolve()
    msg = message or f"Merge {branch} (squash)"
    try:
        check = run_git(["rev-parse", "--git-dir"], resolved)
        if check.returncode != 0:
            repo_err = not_a_repo_error(check.stderr, resolved)
            return ToolResult(
                success=repo_err.success,
                error=repo_err.error,
                data=repo_err.data,
                text=render_failure_text(error=repo_err.error or ""),
            )

        identity = resolve_identity(resolved)
        steps = [
            (["checkout", target_branch], f"checkout {target_branch}"),
            (["merge", "--squash", branch], "merge --squash"),
            (["commit", "-m", msg, *author_args(identity)], "commit"),
        ]
        for args, label in steps:
            failure = _run_step(args, resolved, label)
            if failure is not None:
                return failure
    except subprocess.TimeoutExpired as exc:
        return timeout_error_result(exc)

    data: dict[str, object] = {
        "merged": branch,
        "into": target_branch,
        "message": msg,
    }
    return ToolResult(success=True, data=data, text=render_text(data))