bookmarks.merge() - Mesa Docs

Merge source into target and move target to the merge result. Required scope: write

const result = await mesa.bookmarks.merge({
  repo: 'app',
  target: 'main',
  source: 'feature/auth',
  authors: [{ name: 'Docs Bot', email: 'docs@example.com' }],
  delete_source: true,
});

console.log(result.merge_type, result.change_id);

Resolve conflicts by retrying with resolutions:

await mesa.bookmarks.merge({
  repo: 'app',
  target: 'main',
  source: 'feature/auth',
  authors: [{ name: 'Docs Bot', email: 'docs@example.com' }],
  resolutions: [{ path: 'README.md', take: 'source' }],
});

Options

string

required

Repository name.

string

required

Bookmark being merged into. This bookmark is updated to the merge result.

string

required

Bookmark being merged from.

boolean | undefined

Delete the source bookmark after a successful merge. Defaults to false.

boolean | undefined

Persist a conflicted merge commit instead of rejecting with MERGE_CONFLICT. Defaults to false.

array | undefined

Conflict resolutions to apply before conflict detection. Each resolution targets a path and either supplies whole-file content, takes target or source, or resolves individual hunks.

[{ name: string; email?: string }, ...]

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

object | undefined

A single author, kept for compatibility on a private-key client. Prefer authors, and don’t pass both.

Response

'merge_commit' | 'no_op'

Type of merge that was performed.

boolean

Whether the resulting merge change still contains unresolved conflicts.

string

Commit OID the target bookmark now points to.

string

Change ID the target bookmark points to after the merge.

string

Bookmark that was merged into.

string

Bookmark that was merged from.

boolean

Whether the source bookmark was deleted after the merge.

​Options

​Response

Options

Response