GitHub
Visão geral
Seção intitulada “Visão geral”O GitHub é a maior plataforma de hospedagem de código do mundo, oferecendo controle de versão baseado em Git, rastreamento de issues, revisões de pull requests e integração contínua. Com a integração GitHub no SquadOS, seus agentes podem criar e gerenciar repositórios, abrir issues, revisar e mesclar pull requests, publicar releases e pesquisar código — tudo de forma programática, sem sair da plataforma.
- Site oficial: https://github.com/
- Documentação na Composio: docs.composio.dev/toolkits/github
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.
Você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
oauth_token | Sim | Token de acesso OAuth 2.0 obtido ao autorizar o acesso à sua conta GitHub pela página de conexão da Composio. |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Acesse a página de conexão da Composio (passo “Como conectar no SquadOS” abaixo) e clique em Conectar.
- Você será redirecionado para o GitHub para autorizar o acesso. Faça login se necessário.
- Revise as permissões solicitadas e clique em Authorize.
- O token OAuth é gerado e armazenado automaticamente pela Composio — você não precisa copiá-lo manualmente.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
GitHub. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso via OAuth ao GitHub.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Ações disponíveis
Seção intitulada “Ações disponíveis”Criar issue
Seção intitulada “Criar issue”GITHUB_CREATE_AN_ISSUE
Cria uma nova issue em um repositório do GitHub. O repositório deve existir e ter issues habilitadas. Campos como assignees, milestone e labels podem exigir permissão de push.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Nome do usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem a extensão .git (sem distinção de maiúsculas). |
title | string | Sim | Título da nova issue. |
body | string | Não | Conteúdo textual da issue. |
labels | array | Não | Array de nomes de labels a associar à issue. Exige permissão de push; silenciosamente ignorados caso contrário. |
assignees | array | Não | Logins do GitHub dos usuários a atribuir à issue. Exige permissão de push. |
milestone | string | Não | ID do milestone a associar (ex.: "5"). Exige permissão de push. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter issue
Seção intitulada “Obter issue”GITHUB_GET_AN_ISSUE
Recupera informações detalhadas sobre uma issue específica de um repositório.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Nome do usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem a extensão .git (sem distinção de maiúsculas). |
issue_number | integer | Sim | Número identificador da issue. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar issues do repositório
Seção intitulada “Listar issues do repositório”GITHUB_LIST_REPOSITORY_ISSUES
Lista as issues de um repositório do GitHub (incluindo pull requests). Requer os parâmetros owner e repo.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
state | string | Não | Filtro por estado: "open", "closed" ou "all". |
labels | string | Não | Lista de labels separadas por vírgula para filtrar (ex.: "bug,ui"). |
assignee | string | Não | Filtrar por usuário atribuído. Use "none" para sem atribuição ou "*" para qualquer. |
sort | string | Não | Campo de ordenação: "created", "updated" ou "comments". |
since | string | Não | Retorna apenas issues atualizadas a partir deste timestamp ISO 8601. |
per_page | integer | Não | Número de resultados por página (máx. 100). |
page | integer | Não | Número da página de resultados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar comentário em issue
Seção intitulada “Criar comentário em issue”GITHUB_CREATE_AN_ISSUE_COMMENT
Cria um novo comentário em uma issue ou pull request existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
issue_number | integer | Sim | Número da issue ou pull request onde o comentário será adicionado. |
body | string | Sim | Conteúdo do comentário em GitHub Flavored Markdown. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Adicionar labels a uma issue
Seção intitulada “Adicionar labels a uma issue”GITHUB_ADD_LABELS_TO_AN_ISSUE
Adiciona labels a uma issue do repositório. Labels que não existem são criadas automaticamente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem a extensão .git (sem distinção de maiúsculas). |
issue_number | integer | Sim | Número inteiro positivo que identifica a issue no repositório. Deve ser maior ou igual a 1. |
labels | array | Sim | Array de nomes de labels a adicionar. Labels inexistentes são criadas automaticamente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar pull request
Seção intitulada “Criar pull request”GITHUB_CREATE_A_PULL_REQUEST
Cria um pull request em um repositório do GitHub. Os branches base e head já devem existir. É obrigatório informar title ou issue.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
head | string | Sim | Nome do branch com as alterações. Para PRs entre repositórios, use o formato usuario:branch. O branch já deve existir antes desta chamada. |
base | string | Sim | Nome do branch de destino (no qual as alterações serão mescladas). |
title | string | Não | Título do pull request. Obrigatório se issue não for informado. |
body | string | Não | Descrição detalhada do pull request. |
draft | boolean | Não | Se true, cria o PR como rascunho (não pode ser mesclado até marcado como pronto). |
issue | integer | Não | Número de uma issue existente a converter em pull request. Obrigatório se title não for informado. |
maintainer_can_modify | boolean | Não | Permite que mantenedores do repositório upstream modifiquem o PR (relevante para forks). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter pull request
Seção intitulada “Obter pull request”GITHUB_GET_A_PULL_REQUEST
Recupera informações sobre um pull request específico de um repositório do GitHub.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Nome do usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
pull_number | integer | Sim | Número identificador do pull request. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Mesclar pull request
Seção intitulada “Mesclar pull request”GITHUB_MERGE_A_PULL_REQUEST
Mescla um pull request aberto e mesclável em um repositório. O PR não pode estar em modo rascunho e todas as regras de proteção do branch devem ser atendidas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Nome do usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
pull_number | integer | Sim | Número identificador do pull request. Deve estar aberto, não ser rascunho e ter todas as verificações de proteção satisfeitas. |
merge_method | string | Não | Estratégia de mesclagem: "merge", "squash" ou "rebase". Usa a configuração do repositório se não informado. |
commit_title | string | Não | Título para a mensagem do commit de mesclagem. |
commit_message | string | Não | Detalhes adicionais para a mensagem do commit de mesclagem. |
sha | string | Não | SHA do commit HEAD do PR. Deve corresponder ao estado atual para garantir que o PR não mudou desde a revisão. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar pull requests
Seção intitulada “Listar pull requests”GITHUB_LIST_PULL_REQUESTS
Lista os pull requests de um repositório do GitHub. Os parâmetros owner e repo são obrigatórios.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Nome do usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
state | string | Não | Filtro por estado: "open", "closed" ou "all". |
head | string | Não | Filtrar por branch de origem, no formato usuario:branch. |
base | string | Não | Filtrar por branch de destino. |
sort | string | Não | Campo de ordenação: "created", "updated", "popularity" ou "long-running". |
direction | string | Não | Direção da ordenação: "asc" ou "desc". |
per_page | integer | Não | Número de resultados por página (máx. 100). |
page | integer | Não | Número da página de resultados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar revisão de pull request
Seção intitulada “Criar revisão de pull request”GITHUB_CREATE_A_REVIEW_FOR_A_PULL_REQUEST
Cria uma revisão em um pull request, permitindo aprovação, solicitação de alterações ou comentários. O campo body é obrigatório quando event é REQUEST_CHANGES ou COMMENT. Omitir event deixa a revisão como PENDING.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Nome do usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
pull_number | integer | Sim | Número identificador do pull request. |
event | string | Não | Tipo de ação da revisão: "APPROVE", "REQUEST_CHANGES" ou "COMMENT". Se omitido, a revisão fica como PENDING. |
body | string | Não | Texto principal da revisão. Obrigatório se event for REQUEST_CHANGES ou COMMENT. |
comments | array | Não | Comentários inline. Cada objeto requer path (caminho do arquivo) e body (texto do comentário), com line e side opcionais para posicionamento no diff. |
commit_id | string | Não | SHA do commit a revisar. Padrão: último commit do PR. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter repositório
Seção intitulada “Obter repositório”GITHUB_GET_A_REPOSITORY
Recupera informações detalhadas sobre um repositório GitHub existente e acessível.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Nome do usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar repositório para o usuário autenticado
Seção intitulada “Criar repositório para o usuário autenticado”GITHUB_CREATE_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER
Cria um novo repositório para o usuário autenticado, opcionalmente dentro de uma organização se team_id for informado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do repositório. Deve ser único na conta. Aceita apenas caracteres alfanuméricos, hífens, underscores e pontos. |
description | string | Não | Descrição curta do repositório. |
private | boolean | Não | Se true, cria o repositório como privado. |
auto_init | boolean | Não | Se true, inicializa o repositório com um README. |
license_template | string | Não | Identificador SPDX da licença (ex.: "mit", "apache-2.0"). |
gitignore_template | string | Não | Template de .gitignore desejado (ex.: "Python", "Node"). |
has_issues | boolean | Não | Se issues estão habilitadas. |
has_wiki | boolean | Não | Se o wiki está habilitado. |
has_discussions | boolean | Não | Se discussions estão habilitadas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar fork
Seção intitulada “Criar fork”GITHUB_CREATE_A_FORK
Cria um fork de um repositório acessível, opcionalmente em uma organização específica, com novo nome ou copiando apenas o branch padrão.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Nome do usuário ou organização dona do repositório original (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório original, sem .git (sem distinção de maiúsculas). |
organization | string | Não | Nome da organização do GitHub para criar o fork. Se não informado, o fork é criado na conta do usuário autenticado. |
name | string | Não | Nome desejado para o fork. Se não informado, usa o mesmo nome do repositório original. |
default_branch_only | boolean | Não | Se true, copia apenas o branch padrão. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter branch
Seção intitulada “Obter branch”GITHUB_GET_A_BRANCH
Recupera informações detalhadas de um branch específico de um repositório GitHub.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
branch | string | Sim | Nome do branch. Não aceita caracteres curinga. Use "HEAD" para resolver ao branch padrão do repositório. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar branches
Seção intitulada “Listar branches”GITHUB_LIST_BRANCHES
Lista os branches de um repositório GitHub, com opção de filtrar por status de proteção.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
protected | boolean | Não | Filtrar por status de proteção: true para protegidos, false para desprotegidos; omita para todos. |
per_page | integer | Não | Número de resultados por página (máx. 100). |
page | integer | Não | Número da página de resultados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar commits
Seção intitulada “Listar commits”GITHUB_LIST_COMMITS
Lista os commits de um repositório GitHub. Permite filtrar por branch/SHA, caminho de arquivo, autor, committer ou intervalo de datas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
sha | string | Não | Hash SHA ou nome de branch a partir do qual listar os commits. Padrão: branch padrão do repositório. |
path | string | Não | Retorna apenas commits que modificaram este caminho de arquivo. |
author | string | Não | Filtrar pelo login ou e-mail do autor do commit. |
committer | string | Não | Filtrar pelo login ou e-mail do committer. |
since | string | Não | Retorna apenas commits criados em ou após este timestamp ISO 8601. |
until | string | Não | Retorna apenas commits criados antes deste timestamp ISO 8601. |
per_page | integer | Não | Número de resultados por página (máx. 100). |
page | integer | Não | Número da página de resultados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter commit
Seção intitulada “Obter commit”GITHUB_GET_A_COMMIT
Recupera um commit específico de um repositório pelo SHA, nome de branch ou tag. Suporta paginação para diffs grandes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
ref | string | Sim | Referência do commit: SHA (ex.: abc123), nome de branch (ex.: heads/main) ou tag (ex.: tags/v1.0). |
page | integer | Não | Número da página para paginar o diff do commit, quando muito grande. |
per_page | integer | Não | Número de resultados por página ao paginar o diff (máx. 100). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar ou atualizar conteúdo de arquivo
Seção intitulada “Criar ou atualizar conteúdo de arquivo”GITHUB_CREATE_OR_UPDATE_FILE_CONTENTS
Cria um novo arquivo ou atualiza um existente em um repositório GitHub. O SHA é buscado automaticamente se não for fornecido.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
path | string | Sim | Caminho completo do arquivo no repositório, incluindo nome e extensão. Sem barras iniciais. |
message | string | Sim | Mensagem de commit para esta criação ou atualização. |
content | string | Sim | Conteúdo do arquivo. Pode ser texto simples (será codificado em Base64 automaticamente) ou já codificado em Base64. |
branch | string | Não | Nome do branch. Padrão: branch padrão do repositório. |
sha | string | Não | SHA do blob do arquivo sendo substituído. Buscado automaticamente se não informado. |
author__name | string | Não | Nome do autor. Se informado, author__email também é obrigatório. |
author__email | string | Não | E-mail do autor. Se informado, author__name também é obrigatório. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter conteúdo do repositório
Seção intitulada “Obter conteúdo do repositório”GITHUB_GET_REPOSITORY_CONTENT
Recupera o conteúdo codificado em Base64 de um arquivo ou lista o conteúdo de um diretório em um repositório GitHub.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
path | string | Sim | Caminho do arquivo ou diretório no repositório. String vazia ("") retorna o conteúdo do diretório raiz. NÃO inclua o nome do branch aqui — use o parâmetro ref. |
ref | string | Não | Branch, tag ou SHA do commit a ler. Se não informado, usa o branch padrão do repositório. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar release
Seção intitulada “Criar release”GITHUB_CREATE_A_RELEASE
Cria uma release em um repositório GitHub para uma tag específica. A tag deve ser única para releases publicadas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
tag_name | string | Sim | Nome da tag para esta release. Deve ser único para releases publicadas. |
name | string | Não | Título da release. Se omitido, usa tag_name. |
body | string | Não | Descrição detalhada da release. Aceita Markdown. |
draft | boolean | Não | Se true, cria uma release não publicada (rascunho). Padrão: false. |
prerelease | boolean | Não | Se true, identifica esta release como pré-lançamento. Padrão: false. |
generate_release_notes | boolean | Não | Se true, gera automaticamente o título e a descrição a partir do histórico de commits. |
target_commitish | string | Não | Branch, tag ou SHA a partir do qual a tag Git é criada. Padrão: branch padrão. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter release
Seção intitulada “Obter release”GITHUB_GET_A_RELEASE
Recupera uma release específica de um repositório GitHub.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
release_id | integer | Sim | Identificador numérico único da release. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pesquisar repositórios
Seção intitulada “Pesquisar repositórios”GITHUB_SEARCH_REPOSITORIES
Pesquisa repositórios do GitHub com palavras-chave e qualificadores, com suporte a ordenação, direção e paginação. O parâmetro q é obrigatório.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
q | string | Sim | Query de busca. Qualificadores: language:LANG, stars:N, forks:N, topic:TOPIC, license:LICENSE, user:USERNAME, org:ORGNAME, is:public|private, archived:true|false. Máximo de 5 operadores AND/OR/NOT. |
sort | string | Não | Campo de ordenação: "stars", "forks", "help-wanted-issues", "updated" ou "created". |
order | string | Não | Direção da ordenação: "desc" (padrão) ou "asc". Efetivo apenas com sort. |
per_page | integer | Não | Número de resultados por página (máx. 100). Padrão: 30. |
page | integer | Não | Número da página de resultados. Padrão: 1. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pesquisar código
Seção intitulada “Pesquisar código”GITHUB_SEARCH_CODE
Pesquisa conteúdos e caminhos de arquivos de código nos branches padrão de repositórios GitHub. Pesquisa apenas arquivos menores que 384 KB e retorna no máximo 1.000 resultados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
q | string | Sim | Query de busca de código, incluindo palavras-chave e qualificadores (ex.: language:python, user:octocat, repo:owner/repo). |
per_page | integer | Não | Número de resultados por página (máx. 100). |
page | integer | Não | Número da página de resultados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pesquisar issues e pull requests
Seção intitulada “Pesquisar issues e pull requests”GITHUB_SEARCH_ISSUES_AND_PULL_REQUESTS
Pesquisa issues e pull requests no GitHub. Suporta palavras-chave, qualificadores (repo:, org:, state:, label:, author:, assignee:, etc.) e filtros de tipo (is:issue, is:pr). O atalho @me é resolvido automaticamente para o nome do usuário autenticado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
q | string | Sim | Query de busca usando a sintaxe do GitHub. Filtros de tipo (is:issue, is:pr) não podem ser usados sozinhos — devem ser combinados com pelo menos uma palavra-chave ou outro qualificador. Máximo de 5 operadores AND/OR/NOT. |
sort | string | Não | Campo de ordenação: "comments", "reactions", "created", "updated", entre outros. |
order | string | Não | Direção da ordenação: "asc" ou "desc". Efetivo apenas com sort. |
per_page | integer | Não | Número de resultados por página. |
page | integer | Não | Número da página de resultados. |
response_detail | string | Não | Nível de detalhe: "minimal" (padrão, otimizado para agentes IA) ou "full" (resposta completa da API). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Favoritar repositório
Seção intitulada “Favoritar repositório”GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER
Favorita (estrela) um repositório para o usuário autenticado. Esta ação é idempotente e tem sucesso mesmo que o repositório já esteja favoritado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Nome do usuário ou organização dona do repositório (sem distinção de maiúsculas). |
repo | string | Sim | Nome do repositório, sem .git (sem distinção de maiúsculas). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Commit de múltiplos arquivos
Seção intitulada “Commit de múltiplos arquivos”GITHUB_COMMIT_MULTIPLE_FILES
Cria, atualiza ou exclui atomicamente múltiplos arquivos em um repositório GitHub como um único commit. Usa as Git Data APIs para evitar conflitos de SHA que ocorrem com a Contents API ao modificar vários arquivos em paralelo. Ao fazer commit em um branch novo, é obrigatório fornecer base_branch.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
owner | string | Sim | Usuário ou organização dona do repositório. |
repo | string | Sim | Nome do repositório (sem extensão .git). |
branch | string | Sim | Nome do branch de destino. Se o branch não existir, base_branch é obrigatório. |
message | string | Sim | Mensagem de commit descrevendo as alterações. |
upserts | array | Não | Lista de arquivos a criar ou atualizar. Cada entrada requer path, content e encoding opcional (utf-8 ou base64). |
deletes | array | Não | Lista de caminhos de arquivos a excluir do repositório. Os arquivos devem existir. |
base_branch | string | Não | Obrigatório ao fazer commit em um branch novo que ainda não existe. Especifica o branch existente a partir do qual o novo branch será criado (ex.: "main"). |
author | object | Não | Informações do autor Git. |
committer | object | Não | Informações do committer Git. |
force | boolean | Não | Força a atualização da referência do branch. ATENÇÃO: pode sobrescrever commits. Use apenas quando quiser intencionalmente sobrescrever o histórico. |
max_retries | integer | Não | Máximo de tentativas em caso de condições de corrida (erros 422 not a fast forward). Defina como 0 para desabilitar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |