---
title: Connecter GitHub
description: "Connectez GitHub à Jamdesk pour déployer automatiquement à chaque push. Installation de l'app, sélection du dépôt et configuration de la branche."
---

Jamdesk s'intègre à GitHub pour déployer automatiquement votre documentation lorsque vous poussez des modifications.

Les captures d'écran montrent l'interface en anglais.

<Note>
Pour en savoir plus sur le fonctionnement de la GitHub App et de la liaison de compte personnel, consultez [Comprendre l'intégration GitHub](/fr/integrations/github).
</Note>

## Installation de la GitHub App

Lors de votre première connexion à Jamdesk, vous serez invité à installer la GitHub App Jamdesk. Cette app permet :

- **Accès au dépôt** - Lire le contenu de votre documentation
- **Webhooks** - Déclencher des builds à chaque push
- **Statut de commit** - Afficher l'état du build sur les commits

### Permissions

La GitHub App Jamdesk demande ces permissions :

| Permission | Objectif |
|------------|---------|
| Contenu du dépôt (lecture) | Cloner et lire vos fichiers de documentation |
| Métadonnées (lecture) | Lister les dépôts et les branches |
| Webhooks | Recevoir les notifications de push |

<Note>
Jamdesk n'accède qu'aux dépôts auxquels vous accordez explicitement l'accès. Vous pouvez modifier l'accès à tout moment dans vos paramètres GitHub.
</Note>

## Connecter un dépôt

<Steps>
  <Step title="Sélectionner le dépôt">
    Lors de la création ou de la modification d'un projet, cliquez sur **Connect Repository**.

    Choisissez parmi les dépôts où la GitHub App est installée.
  </Step>

  <Step title="Choisir la branche">
    Sélectionnez la branche à déployer :

    - **main** ou **master** - Les plus courantes pour la documentation en production
    - **docs** - Si vous conservez la documentation dans une branche séparée
    - N'importe quelle branche - Pour les déploiements en preview
  </Step>

  <Step title="Spécifier le chemin de la documentation">
    Si votre `docs.json` ne se trouve pas à la racine du dépôt, spécifiez le chemin :

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

    Laissez vide si `docs.json` se trouve à la racine.
  </Step>
</Steps>

Une fois connecté, le dashboard de votre projet affiche le dépôt et la branche liés :

<img src="/images/dashboard/github-connected.webp" alt="Dashboard showing GitHub repository connected with Linked status badge, repository name, and branch" style={{ display: 'block', margin: '0 auto', maxWidth: '500px' }} />

## Déploiements automatiques

Une fois connecté, chaque push vers votre branche configurée déclenche un build :

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

Les builds se terminent généralement en 30 à 90 secondes. Consultez le statut dans le dashboard ou sur le commit GitHub.

## Changer de dépôt

Pour connecter un autre dépôt :

1. Allez dans **Settings** → **Repository**
2. Cliquez sur **Change Repository**
3. Sélectionnez le nouveau dépôt et la branche

<Warning>
Changer de dépôt peut affecter votre documentation en production. Le nouveau dépôt doit contenir une configuration Jamdesk valide.
</Warning>

## Gérer l'accès à la GitHub App

Contrôlez les dépôts auxquels Jamdesk peut accéder :

1. Rendez-vous sur [github.com/settings/installations](https://github.com/settings/installations)
2. Trouvez **Jamdesk** dans la liste
3. Cliquez sur **Configure**
4. Sous « Repository access », sélectionnez des dépôts spécifiques ou tous

### Dépôts d'organisation

Pour les dépôts d'organisation, un administrateur de l'organisation doit approuver l'installation de la GitHub App :

1. Demandez l'installation depuis votre dashboard Jamdesk
2. Un administrateur reçoit une notification dans GitHub
3. Une fois approuvés, les dépôts de l'organisation apparaissent dans le sélecteur de dépôt

## Lier votre compte personnel

Pour une attribution fiable des builds, liez votre compte GitHub personnel dans **User Settings** :

1. Cliquez sur votre avatar → **User Settings**
2. Trouvez la section **GitHub Account**
3. Cliquez sur **Link GitHub Account**

Cette étape est distincte de la GitHub App et garantit que vos commits vous sont correctement attribués. [En savoir plus](/fr/integrations/github#compte-github-personnel-niveau-utilisateur).

## Dépannage

### Le dépôt n'apparaît pas

- Vérifiez que la GitHub App est installée sur le dépôt
- Pour les dépôts d'organisation, confirmez qu'un administrateur a approuvé l'accès
- Essayez d'actualiser la liste des dépôts dans le dashboard

### Les builds ne se déclenchent pas

- Vérifiez que le Webhook est actif dans les paramètres du dépôt
- Assurez-vous de pousser vers la branche configurée
- Recherchez les erreurs de livraison de Webhook dans GitHub

### Erreurs de permission refusée

- Réautorisez la GitHub App dans vos paramètres GitHub
- Assurez-vous que le dépôt est accessible à l'app Jamdesk

<Note>
  Pour un dépannage plus détaillé, consultez [Comprendre l'intégration GitHub](/fr/integrations/github).
</Note>

## Et ensuite ?

<Columns cols={2}>
  <Card title="Créer un projet" icon="plus" href="/fr/setup/creating-projects">
    Configurer un nouveau projet Jamdesk
  </Card>
  <Card title="Structure des répertoires" icon="folder-tree" href="/fr/setup/directory-structure">
    Organiser votre documentation pour passer à l'échelle
  </Card>
</Columns>