dev.knotless.mergePull

lexicons.knotless.dev

Documentation

Merges an open pull as `knotless merge` does, as the account logged in to this appview's web pages, with the session the appview keeps for it: a fast-forward when the base has not moved, else a merge commit, or one squashed commit into a branch protected as linear. Refused on conflicts, into a branch that takes pulls only through the merge queue (dev.knotless.queuePull queues it), and, in a repository that names runners, until each workflow that runs on it passed at its head merged with its base as it is now; it does not wait. The owner and collaborators may. Its head branch, when in the repository, goes with it unless kept or named by another open pull. Into the default branch, it closes the issues the pull names to close. Requires the session cookie the pages' login sets.

main procedure

Merges an open pull as `knotless merge` does, as the account logged in to this appview's web pages, with the session the appview keeps for it: a fast-forward when the base has not moved, else a merge commit, or one squashed commit into a branch protected as linear. Refused on conflicts, into a branch that takes pulls only through the merge queue (dev.knotless.queuePull queues it), and, in a repository that names runners, until each workflow that runs on it passed at its head merged with its base as it is now; it does not wait. The owner and collaborators may. Its head branch, when in the repository, goes with it unless kept or named by another open pull. Into the default branch, it closes the issues the pull names to close. Requires the session cookie the pages' login sets.

Input

Encodingapplication/json
keepBranch boolean Optional

Keep its head branch.

pull stringat-uri Required

The dev.knotless.pull record.

repo stringat-uri Required

The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.

Output

Encodingapplication/json
closed array Required

The issues it closed.

commit string Required

The commit the target branch now points at, in hex.

deleted string Optional

The head branch the merge deleted.

Errors

NotFound No such repository.
AuthenticationRequired No account is logged in to the pages, or its session has ended.
UpstreamFailure It did not merge, as the reason says: it conflicts, its checks have not passed, its branch takes pulls only through the merge queue, or the account may not merge it.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Merges an open pull as `knotless merge` does, as the account logged in to this appview's web pages, with the session the appview keeps for it: a fast-forward when the base has not moved, else a merge commit, or one squashed commit into a branch protected as linear. Refused on conflicts, into a branch that takes pulls only through the merge queue (dev.knotless.queuePull queues it), and, in a repository that names runners, until each workflow that runs on it passed at its head merged with its base as it is now; it does not wait. The owner and collaborators may. Its head branch, when in the repository, goes with it unless kept or named by another open pull. Into the default branch, it closes the issues the pull names to close. Requires the session cookie the pages' login sets.",
  "errors": [
    {
      "description": "No such repository.",
      "name": "NotFound"
    },
    {
      "description": "No account is logged in to the pages, or its session has ended.",
      "name": "AuthenticationRequired"
    },
    {
      "description": "It did not merge, as the reason says: it conflicts, its checks have not passed, its branch takes pulls only through the merge queue, or the account may not merge it.",
      "name": "UpstreamFailure"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "keepBranch": {
          "default": false,
          "description": "Keep its head branch.",
          "type": "boolean"
        },
        "pull": {
          "description": "The dev.knotless.pull record.",
          "format": "at-uri",
          "type": "string"
        },
        "repo": {
          "description": "The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "repo",
        "pull"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "closed": {
          "description": "The issues it closed.",
          "items": {
            "ref": "#closedIssue",
            "type": "ref"
          },
          "type": "array"
        },
        "commit": {
          "description": "The commit the target branch now points at, in hex.",
          "type": "string"
        },
        "deleted": {
          "description": "The head branch the merge deleted.",
          "type": "string"
        }
      },
      "required": [
        "commit",
        "closed"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}
closedIssue object

An issue the merge closed.

Properties

uri string at-uri Required

The dev.knotless.issue record.

View raw schema 
{
  "description": "An issue the merge closed.",
  "properties": {
    "uri": {
      "description": "The dev.knotless.issue record.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri"
  ],
  "type": "object"
}

Lexicon Garden

@