Déployer un site depuis GitHub
Connectez un dépôt GitHub public ou privé à un site compatible et choisissez un déploiement manuel ou automatique à chaque push.
Par Option Hébergement · Mis à jour le · 7 min de lecture
En bref
Tous les comptes Option Hébergement peuvent relier un site compatible à un dépôt GitHub public ou privé. Le déploiement peut être lancé manuellement ou automatiquement à chaque push sur la branche ou le tag suivi.
Cette fonction convient aux sites statiques, aux projets PHP, Laravel, Node.js et aux applications personnalisées. Elle est disponible pour les sites standards et de staging.
Avant de commencer
- Vérifiez que votre projet fonctionne et que son dépôt contient les fichiers nécessaires au déploiement.
- Identifiez la branche ou le tag à suivre.
- Préparez, si nécessaire, la commande de build et le répertoire à publier.
- Vérifiez que les secrets de production ne sont pas enregistrés dans le dépôt.
- Pour une application Node.js ou un autre processus serveur, vérifiez que son exécution est compatible avec les ressources de votre plan.
Avant de remplacer un site existant, conservez une sauvegarde et testez idéalement le projet sur un site de staging.
Connecter votre compte GitHub
La connexion est réalisée une seule fois au niveau de votre compte d’hébergement.
- Connectez-vous à votre espace client.
- Ouvrez GitHub dans le menu principal.
- Cliquez sur Connecter.
- Suivez l’autorisation affichée par GitHub.
- Choisissez uniquement les dépôts auxquels Option Hébergement doit pouvoir accéder.
- Revenez au panneau et vérifiez que le compte, les dépôts et les branches autorisés apparaissent.
Vous pouvez retirer l’autorisation ultérieurement. Une déconnexion au niveau du compte déconnecte également les sites qui utilisent cette connexion.
Relier un site existant
- Ouvrez Sites web.
- Sélectionnez le site de production ou de staging concerné.
- Ouvrez la section GitHub.
- Sélectionnez le dépôt autorisé.
- Choisissez la branche ou le tag à déployer.
- Renseignez la commande de build uniquement si votre projet en nécessite une.
- Indiquez le répertoire de publication lorsque les fichiers publics sont générés dans un sous-dossier, par exemple
distoubuild. - Lancez un premier déploiement manuel.
Si la section GitHub n’apparaît pas, vérifiez que le site n’utilise pas une installation en un clic. En cas de doute, contactez le support avant de modifier le site.
Choisir le mode de déploiement
- Déploiement manuel : vous choisissez le moment où une version du dépôt est mise en ligne.
- Déploiement automatique : chaque push sur la branche ou le tag suivi déclenche un nouveau déploiement.
Commencez par un déploiement manuel. Activez ensuite l’automatisation lorsque la commande de build, les fichiers produits et le comportement du site ont été vérifiés.
Comprendre la mise en ligne
Chaque tentative de déploiement utilise un répertoire distinct. La version courante n’est remplacée qu’après un clonage réussi et, lorsqu’une commande de build est définie, après sa réussite avec un code de sortie 0.
En cas d’échec, la dernière version déployée avec succès reste active. Pour une application serveur, les processus associés sont redémarrés après un déploiement réussi.
Dépôts privés et sécurité
L’autorisation GitHub permet au panneau de lire uniquement les dépôts sélectionnés. Accordez l’accès minimal nécessaire.
Ne placez jamais dans le dépôt :
- mot de passe ;
- clé privée ;
- jeton d’API ;
- accès à une base de données ;
- fichier de configuration contenant des secrets.
Utilisez les mécanismes de variables ou secrets prévus pour l’environnement d’hébergement. Si vous ne savez pas où stocker une valeur confidentielle, contactez le support avant le premier déploiement.
Limites à connaître
- Le lien GitHub n’est pas copié automatiquement lors du clonage d’un site ou du passage d’un staging vers la production.
- Déconnecter un dépôt ne supprime pas les fichiers déjà déployés et ne détruit pas l’historique des déploiements.
- Un nouveau déploiement peut annuler une tentative encore en cours.
- Les fichiers externes absents du dépôt doivent être servis depuis un emplacement prévu à cet effet.
- GitHub est actuellement la plateforme directement prise en charge par cette fonction.
Besoin d’aide ?
Pour une application Node.js, consultez Déployer une application Node.js.
Si un déploiement échoue, contactez le support en indiquant le domaine, le dépôt, la branche ou le tag, la commande de build et le message d’erreur. Ne transmettez aucun mot de passe, jeton ou secret.