bookmarks.merge() - Mesa Docs

Merge source into target. The target bookmark advances to the merge result. Required scope: write

result = await mesa.bookmarks.merge(
    repo="app",
    source="feature-x",
    target="main",
    authors=[{"name": "Docs Bot", "email": "docs@example.com"}],
    delete_source=True,
)
print(result.merge_type, result.change_id)

Resolve conflicts on retry:

from mesa_sdk import WholeFileResolution

result = await mesa.bookmarks.merge(
    repo="app",
    source="feature-x",
    target="main",
    authors=[{"name": "Docs Bot", "email": "docs@example.com"}],
    resolutions=[WholeFileResolution(path="README.md", take="source")],
)

Options

str

required

Repository name.

str

required

Source bookmark with changes to merge.

str

required

Target bookmark to advance.

bool | None

Delete the source bookmark after a successful merge.

bool | None

When True, accept a merge that still contains textual conflicts. When omitted or False, conflicted merges fail with ConflictError.

list[Resolution] | None

Whole-file or per-hunk conflict resolutions applied before conflict detection.

list[SigningKeyAuthor] | None

Commit authors, in order, with at least one entry. Private-key clients set this.

Author | None

A single author, kept for compatibility on a private-key client. Prefer authors, and don’t pass both. Access-token clients cannot override the authors encoded in their token.

str | None

Organization override.

Response

'merge_commit' | 'no_op'

Type of merge that was performed.

bool

Whether the resulting merge change still contains unresolved conflicts.

str

Commit OID the target bookmark now points to.

str

Change ID the target bookmark points to after the merge.

str

Bookmark that was merged into.

str

Bookmark that was merged from.

bool

Whether the source bookmark was deleted after the merge.

​Options

​Response

Options

Response