GitHub é a plataforma líder mundial para desenvolvimento de software e controle de versão usando Git. Ela fornece um ambiente colaborativo onde desenvolvedores podem hospedar e revisar código, gerenciar projetos e construir software juntos.
Com o GitHub, você pode:
- Hospedar repositórios: Armazene seu código em repositórios públicos ou privados com controle de versão
- Colaborar em código: Use pull requests para propor mudanças, revisar código e mesclar contribuições
- Rastrear issues: Crie, atribua e gerencie issues para organizar trabalho e rastrear bugs
- Automatizar workflows: Use GitHub Actions para construir, testar e implantar código automaticamente
- Gerenciar projetos: Organize trabalho com quadros de projeto, milestones e rastreamento de tarefas
- Documentar código: Crie e mantenha documentação com GitHub Pages e wikis
No ZippyVendas, a integração GitHub permite que seus agentes interajam diretamente com repositórios e workflows do GitHub. Isso possibilita cenários de automação poderosos como assistência de revisão de código, gerenciamento de pull requests, rastreamento de issues e exploração de repositórios. Seus agentes podem buscar dados de repositórios, analisar mudanças de código, postar comentários em pull requests e realizar outras operações do GitHub programaticamente. Esta integração faz a ponte entre seus workflows de IA e seus processos de desenvolvimento, permitindo colaboração perfeita entre seus agentes e sua equipe de desenvolvimento.
Integre o Github ao workflow. Pode obter detalhes de PR, criar comentário em PR, obter informações do repositório e obter último commit. Pode ser usado em modo trigger para acionar um workflow quando um PR é criado, comentado ou um commit é enviado.
Buscar detalhes do PR incluindo diff e arquivos alterados
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
pullNumber | number | Sim | Número do pull request |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Resumo do PR legível |
metadata | object | Metadados detalhados do PR incluindo mudanças de arquivo |
Criar comentários em PRs do GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
body | string | Sim | Conteúdo do comentário |
pullNumber | number | Sim | Número do pull request |
path | string | Não | Caminho do arquivo para comentário de revisão |
position | number | Não | Número da linha para comentário de revisão |
commentType | string | Não | Tipo de comentário (pr_comment ou file_comment) |
line | number | Não | Número da linha para comentário de revisão |
side | string | Não | Lado do diff (LEFT ou RIGHT) |
commitId | string | Não | O SHA do commit para comentar |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de comentário legível |
metadata | object | Metadados do comentário |
Recuperar metadados abrangentes do repositório GitHub incluindo stars, forks, issues e linguagem principal. Suporta repositórios públicos e privados com autenticação opcional.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Resumo do repositório legível |
metadata | object | Metadados do repositório |
Recuperar o último commit de um repositório GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
branch | string | Não | Nome da branch (usa a branch padrão do repositório se não especificado) |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Resumo do commit legível |
metadata | object | Metadados do commit |
Criar um comentário em uma issue do GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
issue_number | number | Sim | Número da issue |
body | string | Sim | Conteúdo do comentário |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de comentário legível |
metadata | object | Metadados do comentário |
Listar todos os comentários em uma issue do GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
issue_number | number | Sim | Número da issue |
since | string | Não | Mostrar apenas comentários atualizados após este timestamp ISO 8601 |
per_page | number | Não | Número de resultados por página (máx 100) |
page | number | Não | Número da página |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Resumo de comentários legível |
metadata | object | Metadados da lista de comentários |
Atualizar um comentário existente em uma issue ou pull request do GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
comment_id | number | Sim | ID do comentário |
body | string | Sim | Conteúdo atualizado do comentário |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de atualização legível |
metadata | object | Metadados do comentário atualizado |
Deletar um comentário em uma issue ou pull request do GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
comment_id | number | Sim | ID do comentário |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de deleção legível |
metadata | object | Metadados do resultado da deleção |
Listar todos os comentários de revisão em um pull request do GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
pullNumber | number | Sim | Número do pull request |
sort | string | Não | Ordenar por created ou updated |
direction | string | Não | Direção da ordenação (asc ou desc) |
since | string | Não | Mostrar apenas comentários atualizados após este timestamp ISO 8601 |
per_page | number | Não | Número de resultados por página (máx 100) |
page | number | Não | Número da página |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Resumo de comentários de revisão legível |
metadata | object | Metadados da lista de comentários de revisão |
Criar um novo pull request em um repositório GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
title | string | Sim | Título do pull request |
head | string | Sim | O nome da branch onde suas mudanças estão implementadas |
base | string | Sim | O nome da branch para onde você quer que as mudanças sejam mescladas |
body | string | Não | Descrição do pull request (Markdown) |
draft | boolean | Não | Criar como pull request de rascunho |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de criação do PR legível |
metadata | object | Metadados do pull request |
Atualizar um pull request existente em um repositório GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
pullNumber | number | Sim | Número do pull request |
title | string | Não | Novo título do pull request |
body | string | Não | Nova descrição do pull request (Markdown) |
state | string | Não | Novo estado (open ou closed) |
base | string | Não | Novo nome da branch base |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de atualização do PR legível |
metadata | object | Metadados do pull request atualizado |
Mesclar um pull request em um repositório GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
pullNumber | number | Sim | Número do pull request |
commit_title | string | Não | Título para o commit de merge |
commit_message | string | Não | Detalhe extra para anexar à mensagem de commit de merge |
merge_method | string | Não | Método de merge: merge, squash ou rebase |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de merge legível |
metadata | object | Metadados do resultado do merge |
Listar pull requests em um repositório GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
state | string | Não | Filtrar por estado: open, closed ou all |
head | string | Não | Filtrar por usuário head ou nome da branch (formato: user:ref-name ou organization:ref-name) |
base | string | Não | Filtrar por nome da branch base |
sort | string | Não | Ordenar por: created, updated, popularity ou long-running |
direction | string | Não | Direção da ordenação: asc ou desc |
per_page | number | Não | Resultados por página (máx 100) |
page | number | Não | Número da página |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Lista de pull requests legível |
metadata | object | Metadados da lista de pull requests |
Obter a lista de arquivos alterados em um pull request
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
pullNumber | number | Sim | Número do pull request |
per_page | number | Não | Resultados por página (máx 100) |
page | number | Não | Número da página |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Lista de arquivos alterados no PR legível |
metadata | object | Metadados dos arquivos do PR |
Fechar um pull request em um repositório GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
pullNumber | number | Sim | Número do pull request |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de fechamento do PR legível |
metadata | object | Metadados do pull request fechado |
Solicitar revisores para um pull request
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
pullNumber | number | Sim | Número do pull request |
reviewers | string | Sim | Lista separada por vírgula de logins de usuários para solicitar revisões |
team_reviewers | string | Não | Lista separada por vírgula de slugs de equipes para solicitar revisões |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de solicitação de revisores legível |
metadata | object | Metadados dos revisores solicitados |
Obter o conteúdo de um arquivo de um repositório GitHub. Suporta arquivos até 1MB. O conteúdo é retornado decodificado e legível.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
path | string | Sim | Caminho para o arquivo no repositório (ex.: "src/index.ts") |
ref | string | Não | Nome da branch, tag ou SHA do commit (usa a branch padrão do repositório se não especificado) |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Informações do arquivo legíveis com prévia do conteúdo |
metadata | object | Metadados do arquivo incluindo nome, caminho, SHA, tamanho e URLs |
Criar um novo arquivo em um repositório GitHub. O conteúdo do arquivo será automaticamente codificado em Base64. Suporta arquivos até 1MB.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
path | string | Sim | Caminho onde o arquivo será criado (ex.: "src/newfile.ts") |
message | string | Sim | Mensagem de commit para esta criação de arquivo |
content | string | Sim | Conteúdo do arquivo (texto plano, será codificado em Base64 automaticamente) |
branch | string | Não | Branch para criar o arquivo (usa a branch padrão do repositório se não especificado) |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de criação de arquivo legível |
metadata | object | Metadados do arquivo e commit |
Atualizar um arquivo existente em um repositório GitHub. Requer o SHA do arquivo. O conteúdo será automaticamente codificado em Base64. Suporta arquivos até 1MB.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
path | string | Sim | Caminho para o arquivo a atualizar (ex.: "src/index.ts") |
message | string | Sim | Mensagem de commit para esta atualização de arquivo |
content | string | Sim | Novo conteúdo do arquivo (texto plano, será codificado em Base64 automaticamente) |
sha | string | Sim | O SHA do blob do arquivo sendo substituído (obtenha de github_get_file_content) |
branch | string | Não | Branch para atualizar o arquivo (usa a branch padrão do repositório se não especificado) |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de atualização de arquivo legível |
metadata | object | Metadados do arquivo atualizado e commit |
Deletar um arquivo de um repositório GitHub. Requer o SHA do arquivo. Esta operação não pode ser desfeita através da API.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
path | string | Sim | Caminho para o arquivo a deletar (ex.: "src/oldfile.ts") |
message | string | Sim | Mensagem de commit para esta deleção de arquivo |
sha | string | Sim | O SHA do blob do arquivo sendo deletado (obtenha de github_get_file_content) |
branch | string | Não | Branch para deletar o arquivo (usa a branch padrão do repositório se não especificado) |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de deleção de arquivo legível |
metadata | object | Confirmação de deleção e metadados do commit |
Obter o conteúdo de um diretório em um repositório GitHub. Retorna uma lista de arquivos e subdiretórios. Use caminho vazio ou omita para obter conteúdo do diretório raiz.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
path | string | Não | Caminho do diretório (ex.: "src/components"). Deixe vazio para diretório raiz. |
ref | string | Não | Nome da branch, tag ou SHA do commit (usa a branch padrão do repositório se não especificado) |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Listagem da árvore de diretórios legível |
metadata | object | Metadados do conteúdo do diretório |
Listar todas as branches em um repositório GitHub. Opcionalmente filtre por status de proteção e controle paginação.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
protected | boolean | Não | Filtrar branches por status de proteção |
per_page | number | Não | Número de resultados por página (máx 100, padrão 30) |
page | number | Não | Número da página para paginação (padrão 1) |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Lista de branches legível |
metadata | object | Metadados da lista de branches |
Obter informações detalhadas sobre uma branch específica em um repositório GitHub, incluindo detalhes do commit e status de proteção.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
branch | string | Sim | Nome da branch |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Detalhes da branch legíveis |
metadata | object | Metadados da branch |
Criar uma nova branch em um repositório GitHub criando uma referência git apontando para um SHA de commit específico.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
branch | string | Sim | Nome da branch a criar |
sha | string | Sim | SHA do commit para onde a branch apontará |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de criação de branch legível |
metadata | object | Metadados da referência git |
Deletar uma branch de um repositório GitHub removendo sua referência git. Branches protegidas não podem ser deletadas.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
branch | string | Sim | Nome da branch a deletar |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de deleção legível |
metadata | object | Metadados da deleção |
Obter as regras de proteção de branch para uma branch específica, incluindo verificações de status, requisitos de revisão e restrições.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
branch | string | Sim | Nome da branch |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Resumo de proteção de branch legível |
metadata | object | Configuração de proteção de branch |
Atualizar regras de proteção de branch para uma branch específica, incluindo verificações de status, requisitos de revisão, aplicação a admins e restrições de push.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
branch | string | Sim | Nome da branch |
required_status_checks | object | Sim | Configuração de verificação de status obrigatória (null para desabilitar). Objeto com strict (boolean) e contexts (array de strings) |
enforce_admins | boolean | Sim | Se deve aplicar restrições para administradores |
required_pull_request_reviews | object | Sim | Requisitos de revisão de PR (null para desabilitar). Objeto com required_approving_review_count opcional, dismiss_stale_reviews, require_code_owner_reviews |
restrictions | object | Sim | Restrições de push (null para desabilitar). Objeto com users (array de strings) e teams (array de strings) |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Resumo de atualização de proteção de branch legível |
metadata | object | Configuração de proteção de branch atualizada |
Criar uma nova issue em um repositório GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
title | string | Sim | Título da issue |
body | string | Não | Descrição/corpo da issue |
assignees | string | Não | Lista separada por vírgula de nomes de usuário para atribuir a esta issue |
labels | string | Não | Lista separada por vírgula de nomes de labels para adicionar a esta issue |
milestone | number | Não | Número do milestone para associar a esta issue |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de criação de issue legível |
metadata | object | Metadados da issue |
Atualizar uma issue existente em um repositório GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
issue_number | number | Sim | Número da issue |
title | string | Não | Novo título da issue |
body | string | Não | Nova descrição/corpo da issue |
state | string | Não | Estado da issue (open ou closed) |
labels | array | Não | Array de nomes de labels (substitui todas as labels existentes) |
assignees | array | Não | Array de nomes de usuário (substitui todos os atribuídos existentes) |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de atualização de issue legível |
metadata | object | Metadados da issue atualizada |
Listar issues em um repositório GitHub. Nota: Isso inclui pull requests pois PRs são considerados issues no GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
state | string | Não | Filtrar por estado: open, closed ou all (padrão: open) |
assignee | string | Não | Filtrar por nome de usuário atribuído |
creator | string | Não | Filtrar por nome de usuário criador |
labels | string | Não | Lista separada por vírgula de nomes de labels para filtrar |
sort | string | Não | Ordenar por: created, updated ou comments (padrão: created) |
direction | string | Não | Direção da ordenação: asc ou desc (padrão: desc) |
per_page | number | Não | Resultados por página (máx 100, padrão: 30) |
page | number | Não | Número da página (padrão: 1) |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Lista de issues legível |
metadata | object | Metadados da lista de issues |
Obter informações detalhadas sobre uma issue específica em um repositório GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
issue_number | number | Sim | Número da issue |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Detalhes da issue legíveis |
metadata | object | Metadados detalhados da issue |
Fechar uma issue em um repositório GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
issue_number | number | Sim | Número da issue |
state_reason | string | Não | Motivo do fechamento: completed ou not_planned |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de fechamento de issue legível |
metadata | object | Metadados da issue fechada |
Adicionar labels a uma issue em um repositório GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
issue_number | number | Sim | Número da issue |
labels | string | Sim | Lista separada por vírgula de nomes de labels para adicionar à issue |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de labels legível |
metadata | object | Metadados das labels |
Remover uma label de uma issue em um repositório GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
issue_number | number | Sim | Número da issue |
name | string | Sim | Nome da label a remover |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de remoção de label legível |
metadata | object | Metadados das labels restantes |
Adicionar atribuídos a uma issue em um repositório GitHub
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório |
repo | string | Sim | Nome do repositório |
issue_number | number | Sim | Número da issue |
assignees | string | Sim | Lista separada por vírgula de nomes de usuário para atribuir à issue |
apiKey | string | Sim | Token de API do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de atribuídos legível |
metadata | object | Metadados da issue atualizada com atribuídos |
Criar uma nova release para um repositório GitHub. Especifique nome da tag, commit alvo, título, descrição e se deve ser um rascunho ou pré-release.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
tag_name | string | Sim | O nome da tag para esta release |
target_commitish | string | Não | Especifica o valor commitish que determina onde a tag Git é criada. Pode ser qualquer branch ou SHA de commit. Usa a branch padrão do repositório se não especificado. |
name | string | Não | O nome da release |
body | string | Não | Texto descrevendo o conteúdo da release (markdown suportado) |
draft | boolean | Não | true para criar uma release de rascunho (não publicada), false para criar uma publicada |
prerelease | boolean | Não | true para identificar a release como pré-release, false para identificar como release completa |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Resumo de criação de release legível |
metadata | object | Metadados da release incluindo URLs de download |
Atualizar uma release existente do GitHub. Modificar nome da tag, commit alvo, título, descrição, status de rascunho ou status de pré-release.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
release_id | number | Sim | O identificador único da release |
tag_name | string | Não | O nome da tag |
target_commitish | string | Não | Especifica o valor commitish para onde a tag é criada |
name | string | Não | O nome da release |
body | string | Não | Texto descrevendo o conteúdo da release (markdown suportado) |
draft | boolean | Não | true para definir como rascunho, false para publicar |
prerelease | boolean | Não | true para identificar como pré-release, false para release completa |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Resumo de atualização de release legível |
metadata | object | Metadados da release atualizada incluindo URLs de download |
Listar todas as releases de um repositório GitHub. Retorna informações da release incluindo tags, nomes e URLs de download.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
per_page | number | Não | Número de resultados por página (máx 100) |
page | number | Não | Número da página dos resultados a buscar |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Lista de releases legível com resumo |
metadata | object | Metadados das releases |
Obter informações detalhadas sobre uma release específica do GitHub por ID. Retorna metadados da release incluindo assets e URLs de download.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
release_id | number | Sim | O identificador único da release |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Detalhes da release legíveis |
metadata | object | Metadados da release incluindo URLs de download |
Deletar uma release do GitHub por ID. Isso remove permanentemente a release mas não deleta a tag Git associada.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
release_id | number | Sim | O identificador único da release a deletar |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Confirmação de deleção legível |
metadata | object | Metadados do resultado da deleção |
Listar todos os workflows em um repositório GitHub. Retorna detalhes do workflow incluindo ID, nome, caminho, estado e URL do badge.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
per_page | number | Não | Número de resultados por página (padrão: 30, máx: 100) |
page | number | Não | Número da página dos resultados a buscar (padrão: 1) |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Resumo de workflows legível |
metadata | object | Metadados dos workflows |
Obter detalhes de um workflow específico do GitHub Actions por ID ou nome de arquivo. Retorna informações do workflow incluindo nome, caminho, estado e URL do badge.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
workflow_id | string | Sim | ID do workflow (número) ou nome do arquivo do workflow (ex.: "main.yaml") |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Detalhes do workflow legíveis |
metadata | object | Metadados do workflow |
Acionar um evento workflow dispatch para um workflow do GitHub Actions. O workflow deve ter um trigger workflow_dispatch configurado. Retorna 204 No Content em sucesso.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
workflow_id | string | Sim | ID do workflow (número) ou nome do arquivo do workflow (ex.: "main.yaml") |
ref | string | Sim | Referência Git (nome de branch ou tag) para executar o workflow |
inputs | object | Não | Chaves e valores de entrada configurados no arquivo do workflow |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Mensagem de confirmação |
metadata | object | Objeto de metadados vazio (resposta 204 No Content) |
Listar execuções de workflow para um repositório. Suporta filtragem por ator, branch, evento e status. Retorna detalhes da execução incluindo status, conclusão e links.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
actor | string | Não | Filtrar por usuário que acionou o workflow |
branch | string | Não | Filtrar por nome da branch |
event | string | Não | Filtrar por tipo de evento (ex.: push, pull_request, workflow_dispatch) |
status | string | Não | Filtrar por status (queued, in_progress, completed, waiting, requested, pending) |
per_page | number | Não | Número de resultados por página (padrão: 30, máx: 100) |
page | number | Não | Número da página dos resultados a buscar (padrão: 1) |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Resumo de execuções de workflow legível |
metadata | object | Metadados das execuções de workflow |
Obter informações detalhadas sobre uma execução de workflow específica por ID. Retorna status, conclusão, tempo e links para a execução.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
run_id | number | Sim | ID da execução do workflow |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Detalhes da execução de workflow legíveis |
metadata | object | Metadados da execução de workflow |
Cancelar uma execução de workflow. Retorna 202 Accepted se o cancelamento for iniciado, ou 409 Conflict se a execução não puder ser cancelada (já concluída).
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
run_id | number | Sim | ID da execução do workflow a cancelar |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Mensagem de status do cancelamento |
metadata | object | Metadados do cancelamento |
Reexecutar uma execução de workflow. Opcionalmente habilite logging de debug para a reexecução. Retorna 201 Created em sucesso.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner | string | Sim | Proprietário do repositório (usuário ou organização) |
repo | string | Sim | Nome do repositório |
run_id | number | Sim | ID da execução do workflow a reexecutar |
enable_debug_logging | boolean | Não | Habilitar logging de debug para a reexecução (padrão: false) |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Mensagem de confirmação de reexecução |
metadata | object | Metadados da reexecução |
Listar GitHub Projects V2 para uma organização ou usuário. Retorna até 20 projetos com seus detalhes incluindo ID, título, número, URL e status.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner_type | string | Sim | Tipo de proprietário: "org" para organização ou "user" para usuário |
owner_login | string | Sim | Nome de login da organização ou usuário |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub com permissões de leitura de projeto |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Lista de projetos legível |
metadata | object | Metadados dos projetos |
Obter informações detalhadas sobre um GitHub Project V2 específico pelo seu número. Retorna detalhes do projeto incluindo ID, título, descrição, URL e status.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner_type | string | Sim | Tipo de proprietário: "org" para organização ou "user" para usuário |
owner_login | string | Sim | Nome de login da organização ou usuário |
project_number | number | Sim | Número do projeto |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub com permissões de leitura de projeto |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Detalhes do projeto legíveis |
metadata | object | Metadados do projeto |
Criar um novo GitHub Project V2. Requer o Node ID do proprietário (não o nome de login). Retorna o projeto criado com ID, título e URL.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
owner_id | string | Sim | Node ID do proprietário (formato: PVT_... ou MDQ6...). Use a API GraphQL do GitHub para obter este ID do login da organização ou usuário. |
title | string | Sim | Título do projeto |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub com permissões de escrita de projeto |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Mensagem de confirmação legível |
metadata | object | Metadados do projeto criado |
Atualizar um GitHub Project V2 existente. Pode atualizar título, descrição, visibilidade (public) ou status (closed). Requer o Node ID do projeto.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
project_id | string | Sim | Node ID do projeto (formato: PVT_...) |
title | string | Não | Novo título do projeto |
shortDescription | string | Não | Nova descrição curta do projeto |
project_public | boolean | Não | Definir visibilidade do projeto (true = público, false = privado) |
closed | boolean | Não | Definir status do projeto (true = fechado, false = aberto) |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub com permissões de escrita de projeto |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Mensagem de confirmação legível |
metadata | object | Metadados do projeto atualizado |
Deletar um GitHub Project V2. Esta ação é permanente e não pode ser desfeita. Requer o Node ID do projeto.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
project_id | string | Sim | Node ID do projeto (formato: PVT_...) |
apiKey | string | Sim | Token de Acesso Pessoal do GitHub com permissões de admin de projeto |
| Parâmetro | Tipo | Descrição |
|---|
content | string | Mensagem de confirmação legível |
metadata | object | Metadados do projeto deletado |
- Categoria:
tools
- Tipo:
github