Fazer merge de pull request no GitHub, por uma API

Faz o merge de um pull request na sua branch base e retorna merged e o sha do novo commit. Responde 405 quando o pull request não pode ser mesclado, e 409 quando o sha não bate mais com o head. Repositórios que fazem merge por merge queue não aceitam esta chamada.

Identificador
github_merge_pull_request

A chamada

POST https://connect.reportei.com/api/tools/github_merge_pull_request/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "owner": "<owner>",
    "repo": "<repo>",
    "pull_number": 1
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
ownerstringSimLogin of the user or organization that owns the repository, the owner.login of List repositories.
repostringSimName of the repository, the name of List repositories.
pull_numberintegerSimNumber of the pull request, the number of List pull requests or Search issues.
merge_methodstringNãoHow to merge. The default is merge; the repository may allow only some methods.Valores: merge, squash, rebase
commit_titlestringNãoTitle of the merge commit.
commit_messagestringNãoExtra text for the merge commit message.
shastringNãoThe head.sha of Get pull request. The merge only happens if the branch still points to it.

Conexões possíveis

O seu cliente conecta a conta do GitHub uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/github, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/github_merge_pull_request. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do GitHub

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.