Collega GitHub
Collega il tuo repository GitHub a Jamdesk per deploy automatici al push. Include installazione dell'app, selezione del repository e configurazione del branch.
Jamdesk si integra con GitHub per eseguire automaticamente il deploy della documentazione quando invii le modifiche.
Gli screenshot mostrano l'interfaccia in inglese.
Per informazioni sul funzionamento congiunto dell'app GitHub e del collegamento dell'account personale, consulta Informazioni sull'integrazione GitHub.
Installazione dell'app GitHub
Quando accedi a Jamdesk per la prima volta, ti verrà chiesto di installare l'app GitHub di Jamdesk. Questa app consente di:
- Accesso al repository - Leggere i contenuti della documentazione
- Webhook - Attivare i build al push
- Stato del commit - Mostrare lo stato del build sui commit
Autorizzazioni
L'app GitHub di Jamdesk richiede le seguenti autorizzazioni:
| Autorizzazione | Scopo |
|---|---|
| Contenuti del repository (lettura) | Clonare e leggere i file della documentazione |
| Metadati (lettura) | Elencare repository e branch |
| Webhook | Ricevere notifiche dei push |
Jamdesk accede solo ai repository a cui concedi esplicitamente l'accesso. Puoi modificare l'accesso in qualsiasi momento nelle impostazioni di GitHub.
Collega un repository
Quando crei o modifichi un progetto, fai clic su Connect Repository.
Scegli tra i repository in cui è installata l'app GitHub.
Seleziona il branch da sottoporre a deploy:
- main o master - I più comuni per la documentazione in produzione
- docs - Se conservi la documentazione in un branch separato
- Qualsiasi branch - Per i deploy di anteprima
Se il file docs.json non si trova nella directory principale del repository, specifica il percorso:
docs/ # Docs in a subdirectory
packages/docs/ # Monorepo with docs packageLascia vuoto se docs.json si trova nella directory principale.
Dopo il collegamento, il dashboard del progetto mostra il repository e il branch collegati:
Deploy automatici
Dopo il collegamento, ogni push al branch configurato attiva un build:
git add .
git commit -m "Update API documentation"
git push origin mainI build vengono generalmente completati in 30-90 secondi. Visualizza lo stato nel dashboard o sul commit GitHub.
Cambiare repository
Per collegare un repository diverso:
- Vai a Settings → Repository
- Fai clic su Change Repository
- Seleziona il nuovo repository e branch
La modifica dei repository può influire sulla documentazione attiva. Il nuovo repository deve contenere una configurazione Jamdesk valida.
Gestire l'accesso all'app GitHub
Controlla a quali repository può accedere Jamdesk:
- Vai a github.com/settings/installations
- Trova Jamdesk nell'elenco
- Fai clic su Configure
- In "Repository access", seleziona repository specifici o tutti
Repository dell'organizzazione
Per i repository dell'organizzazione, un amministratore dell'organizzazione deve approvare l'installazione dell'app GitHub:
- Richiedi l'installazione dal dashboard di Jamdesk
- Un amministratore riceve una notifica in GitHub
- Dopo l'approvazione, i repository dell'organizzazione vengono visualizzati nel selettore dei repository
Collega il tuo account personale
Per un'attribuzione affidabile dei build, collega il tuo account GitHub personale in User Settings:
- Fai clic sul tuo avatar → User Settings
- Trova la sezione GitHub Account
- Fai clic su Link GitHub Account
Questa operazione è separata dall'app GitHub e garantisce che i tuoi commit vengano attribuiti correttamente a te. Scopri di più.
Risoluzione dei problemi
Il repository non viene visualizzato
- Verifica che l'app GitHub sia installata nel repository
- Per i repository dell'organizzazione, verifica che un amministratore abbia approvato l'accesso
- Prova ad aggiornare l'elenco dei repository nel dashboard
I build non si attivano
- Verifica che il webhook sia attivo nelle impostazioni del repository
- Verifica di eseguire il push al branch configurato
- Cerca gli errori di consegna dei webhook in GitHub
Errori di autorizzazione negata
- Autorizza nuovamente l'app GitHub nelle impostazioni di GitHub
- Assicurati che il repository sia accessibile all'app Jamdesk
Per una risoluzione dei problemi più dettagliata, consulta Informazioni sull'integrazione GitHub.