---
title: Conectar GitHub
description: "Conecte seu repositório GitHub ao Jamdesk para implantações automáticas a cada push, configurando o app, o repositório e a branch."
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

O Jamdesk integra-se ao GitHub para implantar automaticamente sua documentação quando você envia alterações.

As capturas de tela mostram a interface em inglês.

<Note>
Para entender como o GitHub App e a vinculação da conta pessoal funcionam em conjunto, consulte [Entender a integração com o GitHub](/pt/integrations/github).
</Note>

## Instalação do GitHub App

Ao entrar no Jamdesk pela primeira vez, você será solicitado a instalar o GitHub App do Jamdesk. Esse app permite:

- **Acesso ao repositório** - Ler o conteúdo da sua documentação
- **Webhooks** - Acionar builds a cada push
- **Status do commit** - Mostrar o status do build nos commits

### Permissões

O GitHub App do Jamdesk solicita estas permissões:

| Permissão | Finalidade |
|------------|---------|
| Conteúdo do repositório (leitura) | Clonar e ler os arquivos da sua documentação |
| Metadados (leitura) | Listar repositórios e branches |
| Webhooks | Receber notificações de push |

<Note>
O Jamdesk acessa apenas os repositórios aos quais você concede explicitamente acesso. Você pode modificar o acesso a qualquer momento nas configurações do GitHub.
</Note>

## Conectar um repositório

<Steps>
  <Step title="Selecionar repositório">
    Ao criar ou editar um projeto, clique em **Connect Repository**.

    Escolha entre os repositórios nos quais o GitHub App está instalado.
  </Step>

  <Step title="Escolher branch">
    Selecione a branch a ser implantada:

    - **main** ou **master** - Mais comum para documentação em produção
    - **docs** - Se você mantiver a documentação em uma branch separada
    - Qualquer branch - Para implantações de pré-visualização
  </Step>

  <Step title="Especificar o caminho da documentação">
    Se o arquivo `docs.json` não estiver na raiz do repositório, especifique o caminho:

    ```bash
    docs/           # Docs in a subdirectory
    packages/docs/  # Monorepo with docs package
    ```

    Deixe em branco se `docs.json` estiver na raiz.
  </Step>
</Steps>

Depois de conectado, o dashboard do projeto mostra o repositório e a branch vinculados:

<img src="/images/dashboard/github-connected.webp" alt="Dashboard mostrando o repositório GitHub conectado com o selo de status Linked, o nome do repositório e a branch" style={{ display: 'block', margin: '0 auto', maxWidth: '500px' }} />

## Implantações automáticas

Depois de conectado, cada push para a branch configurada aciona um build:

```bash
git add .
git commit -m "Update API documentation"
git push origin main
```

Os builds normalmente são concluídos em 30 a 90 segundos. Veja o status no dashboard ou no commit do GitHub.

## Alterar repositórios

Para conectar um repositório diferente:

1. Acesse **Settings** → **Repository**
2. Clique em **Change Repository**
3. Selecione o novo repositório e a branch

<Warning>
Alterar repositórios pode afetar sua documentação publicada. O novo repositório deve conter uma configuração válida do Jamdesk.
</Warning>

## Gerenciar o acesso do GitHub App

Controle a quais repositórios o Jamdesk pode acessar:

1. Acesse [github.com/settings/installations](https://github.com/settings/installations)
2. Encontre **Jamdesk** na lista
3. Clique em **Configure**
4. Em "Repository access", selecione repositórios específicos ou todos

### Repositórios da organização

Para repositórios de uma organização, um administrador da organização deve aprovar a instalação do GitHub App:

1. Solicite a instalação no dashboard do Jamdesk
2. Um administrador receberá uma notificação no GitHub
3. Depois da aprovação, os repositórios da organização aparecerão no seletor de repositórios

## Vincular sua conta pessoal

Para atribuir os builds de forma confiável, vincule sua conta pessoal do GitHub em **User Settings**:

1. Clique no seu avatar → **User Settings**
2. Encontre a seção **GitHub Account**
3. Clique em **Link GitHub Account**

Isso é separado do GitHub App e garante que seus commits sejam atribuídos corretamente a você. [Saiba mais](/pt/integrations/github#conta-pessoal-do-github-nível-do-usuário).

## Solução de problemas

### Repositório não aparece

- Verifique se o GitHub App está instalado no repositório
- Para repositórios de organizações, confirme se um administrador aprovou o acesso
- Tente atualizar a lista de repositórios no dashboard

### Builds não são acionados

- Verifique se o webhook está ativo nas configurações do repositório
- Confirme se você está enviando alterações para a branch configurada
- Procure erros de entrega do webhook no GitHub

### Erros de permissão negada

- Autorize novamente o GitHub App nas configurações do GitHub
- Confirme se o repositório está acessível ao Jamdesk App

<Note>
  Para obter informações mais detalhadas sobre a solução de problemas, consulte [Entender a integração com o GitHub](/pt/integrations/github).
</Note>

## Próximos passos?

<Columns cols={2}>
  <Card title="Criar um projeto" icon="plus" href="/pt/setup/creating-projects">
    Configure um novo projeto do Jamdesk
  </Card>
  <Card title="Estrutura de diretórios" icon="folder-tree" href="/pt/setup/directory-structure">
    Organize sua documentação para crescer
  </Card>
</Columns>